Setup.hs 101 KB
Newer Older
Edsko de Vries's avatar
Edsko de Vries committed
1 2 3
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE RankNTypes #-}
4
{-# LANGUAGE DeriveGeneric #-}
5 6
-----------------------------------------------------------------------------
-- |
7
-- Module      :  Distribution.Client.Setup
8 9 10 11 12 13 14 15 16
-- Copyright   :  (c) David Himmelstrup 2005
-- License     :  BSD-like
--
-- Maintainer  :  lemmih@gmail.com
-- Stability   :  provisional
-- Portability :  portable
--
--
-----------------------------------------------------------------------------
17
module Distribution.Client.Setup
Edsko de Vries's avatar
Edsko de Vries committed
18 19
    ( globalCommand, GlobalFlags(..), defaultGlobalFlags
    , RepoContext(..), withRepoContext
20
    , configureCommand, ConfigFlags(..), filterConfigureFlags
21
    , configPackageDB', configCompilerAux'
22
    , configureExCommand, ConfigExFlags(..), defaultConfigExFlags
23
    , buildCommand, BuildFlags(..), BuildExFlags(..), SkipAddSourceDepsCheck(..)
24
    , replCommand, testCommand, benchmarkCommand
ttuegel's avatar
ttuegel committed
25
                        , configureExOptions, reconfigureCommand
26
    , installCommand, InstallFlags(..), installOptions, defaultInstallFlags
27
    , defaultSolver, defaultMaxBackjumps
28
    , listCommand, ListFlags(..)
29
    , updateCommand, UpdateFlags(..)
ijones's avatar
ijones committed
30
    , upgradeCommand
31
    , uninstallCommand
32
    , infoCommand, InfoFlags(..)
33
    , fetchCommand, FetchFlags(..)
34
    , freezeCommand, FreezeFlags(..)
35
    , genBoundsCommand
36
    , outdatedCommand, OutdatedFlags(..), IgnoreMajorVersionBumps(..)
37
    , getCommand, unpackCommand, GetFlags(..)
38
    , checkCommand
39
    , formatCommand
40
    , uploadCommand, UploadFlags(..), IsCandidate(..)
41
    , reportCommand, ReportFlags(..)
refold's avatar
refold committed
42
    , runCommand
43
    , initCommand, IT.InitFlags(..)
44
    , sdistCommand, SDistFlags(..), SDistExFlags(..), ArchiveFormat(..)
45
    , win32SelfUpgradeCommand, Win32SelfUpgradeFlags(..)
46
    , actAsSetupCommand, ActAsSetupFlags(..)
refold's avatar
refold committed
47
    , sandboxCommand, defaultSandboxLocation, SandboxFlags(..)
48
    , execCommand, ExecFlags(..)
49
    , userConfigCommand, UserConfigFlags(..)
Maciek Makowski's avatar
Maciek Makowski committed
50
    , manpageCommand
Duncan Coutts's avatar
Duncan Coutts committed
51 52

    , parsePackageArgs
53 54 55
    --TODO: stop exporting these:
    , showRepo
    , parseRepo
56
    , readRepo
57 58
    ) where

59 60 61
import Prelude ()
import Distribution.Client.Compat.Prelude hiding (get)

62
import Distribution.Client.Types
63
         ( Username(..), Password(..), RemoteRepo(..) )
64 65
import Distribution.Client.BuildReports.Types
         ( ReportLevel(..) )
66
import Distribution.Client.Dependency.Types
67
         ( PreSolver(..) )
68
import Distribution.Client.IndexUtils.Timestamp
69
         ( IndexState(..) )
70 71
import qualified Distribution.Client.Init.Types as IT
         ( InitFlags(..), PackageType(..) )
72 73
import Distribution.Client.Targets
         ( UserConstraint, readUserConstraint )
74 75
import Distribution.Utils.NubList
         ( NubList, toNubList, fromNubList)
76

77
import Distribution.Solver.Types.ConstraintSource
78
import Distribution.Solver.Types.Settings
79

80 81
import Distribution.Simple.Compiler ( Compiler, PackageDB, PackageDBStack )
import Distribution.Simple.Program (ProgramDb, defaultProgramDb)
82 83
import Distribution.Simple.Command hiding (boolOpt, boolOpt')
import qualified Distribution.Simple.Command as Command
84
import Distribution.Simple.Configure
85
       ( configCompilerAuxEx, interpretPackageDbFlags, computeEffectiveProfiling )
Duncan Coutts's avatar
Duncan Coutts committed
86
import qualified Distribution.Simple.Setup as Cabal
87
import Distribution.Simple.Setup
88 89
         ( ConfigFlags(..), BuildFlags(..), ReplFlags
         , TestFlags(..), BenchmarkFlags(..)
90
         , SDistFlags(..), HaddockFlags(..)
91
         , readPackageDbList, showPackageDbList
Edsko de Vries's avatar
Edsko de Vries committed
92
         , Flag(..), toFlag, flagToMaybe, flagToList
93 94
         , BooleanFlag(..), optionVerbosity
         , boolOpt, boolOpt', trueArg, falseArg
95
         , optionNumJobs )
96
import Distribution.Simple.InstallDirs
Christiaan Baaij's avatar
Christiaan Baaij committed
97
         ( PathTemplate, InstallDirs(dynlibdir, sysconfdir)
98
         , toPathTemplate, fromPathTemplate )
99
import Distribution.Version
100
         ( Version, mkVersion, nullVersion, anyVersion, thisVersion )
101
import Distribution.Package
102
         ( PackageIdentifier, PackageName, packageName, packageVersion )
103
import Distribution.Types.Dependency
104
import Distribution.PackageDescription
105
         ( BuildType(..), RepoKind(..) )
106
import Distribution.System ( Platform )
107
import Distribution.Text
108
         ( Text(..), display )
109
import Distribution.ReadE
110
         ( ReadE(..), readP_to_E, succeedReadE )
111
import qualified Distribution.Compat.ReadP as Parse
112
         ( ReadP, char, munch1, pfail, sepBy1, (+++) )
113 114
import Distribution.ParseUtils
         ( readPToMaybe )
115
import Distribution.Verbosity
116
         ( Verbosity, lessVerbose, normal, verboseNoFlags )
117
import Distribution.Simple.Utils
118
         ( wrapText, wrapLine )
119
import Distribution.Client.GlobalFlags
Edsko de Vries's avatar
Edsko de Vries committed
120 121 122
         ( GlobalFlags(..), defaultGlobalFlags
         , RepoContext(..), withRepoContext
         )
123

124
import Data.List
125
         ( deleteFirstsBy )
126 127 128 129
import System.FilePath
         ( (</>) )
import Network.URI
         ( parseAbsoluteURI, uriToString )
130

131 132
globalCommand :: [Command action] -> CommandUI GlobalFlags
globalCommand commands = CommandUI {
133
    commandName         = "",
134 135
    commandSynopsis     =
         "Command line interface to the Haskell Cabal infrastructure.",
136 137 138 139
    commandUsage        = \pname ->
         "See http://www.haskell.org/cabal/ for more information.\n"
      ++ "\n"
      ++ "Usage: " ++ pname ++ " [GLOBAL FLAGS] [COMMAND [FLAGS]]\n",
140
    commandDescription  = Just $ \pname ->
141 142 143
      let
        commands' = commands ++ [commandAddAction helpCommandUI undefined]
        cmdDescs = getNormalCommandDescriptions commands'
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
        -- if new commands are added, we want them to appear even if they
        -- are not included in the custom listing below. Thus, we calculate
        -- the `otherCmds` list and append it under the `other` category.
        -- Alternatively, a new testcase could be added that ensures that
        -- the set of commands listed here is equal to the set of commands
        -- that are actually available.
        otherCmds = deleteFirstsBy (==) (map fst cmdDescs)
          [ "help"
          , "update"
          , "install"
          , "fetch"
          , "list"
          , "info"
          , "user-config"
          , "get"
          , "init"
          , "configure"
161
          , "reconfigure"
162 163 164 165 166 167 168 169 170 171 172
          , "build"
          , "clean"
          , "run"
          , "repl"
          , "test"
          , "bench"
          , "check"
          , "sdist"
          , "upload"
          , "report"
          , "freeze"
173
          , "gen-bounds"
174
          , "outdated"
Moritz Angermann's avatar
Moritz Angermann committed
175
          , "doctest"
176 177 178 179 180 181
          , "haddock"
          , "hscolour"
          , "copy"
          , "register"
          , "sandbox"
          , "exec"
182 183 184 185
          , "new-build"
          , "new-configure"
          , "new-repl"
          , "new-freeze"
186 187 188
          , "new-run"
          , "new-test"
          , "new-bench"
189
          , "new-haddock"
190
          ]
191 192
        maxlen    = maximum $ [length name | (name, _) <- cmdDescs]
        align str = str ++ replicate (maxlen - length str) ' '
193 194 195 196 197 198 199 200 201
        startGroup n = " ["++n++"]"
        par          = ""
        addCmd n     = case lookup n cmdDescs of
                         Nothing -> ""
                         Just d -> "  " ++ align n ++ "    " ++ d
        addCmdCustom n d = case lookup n cmdDescs of -- make sure that the
                                                  -- command still exists.
                         Nothing -> ""
                         Just _ -> "  " ++ align n ++ "    " ++ d
202 203
      in
         "Commands:\n"
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
      ++ unlines (
        [ startGroup "global"
        , addCmd "update"
        , addCmd "install"
        , par
        , addCmd "help"
        , addCmd "info"
        , addCmd "list"
        , addCmd "fetch"
        , addCmd "user-config"
        , par
        , startGroup "package"
        , addCmd "get"
        , addCmd "init"
        , par
        , addCmd "configure"
        , addCmd "build"
        , addCmd "clean"
        , par
        , addCmd "run"
        , addCmd "repl"
        , addCmd "test"
        , addCmd "bench"
        , par
        , addCmd "check"
        , addCmd "sdist"
        , addCmd "upload"
        , addCmd "report"
        , par
        , addCmd "freeze"
234
        , addCmd "gen-bounds"
235
        , addCmd "outdated"
Moritz Angermann's avatar
Moritz Angermann committed
236
        , addCmd "doctest"
237 238 239 240
        , addCmd "haddock"
        , addCmd "hscolour"
        , addCmd "copy"
        , addCmd "register"
241
        , addCmd "reconfigure"
242 243
        , par
        , startGroup "sandbox"
244
        , addCmd "sandbox"
245 246
        , addCmd "exec"
        , addCmdCustom "repl" "Open interpreter with access to sandbox packages."
247 248 249 250 251
        , par
        , startGroup "new-style projects (beta)"
        , addCmd "new-build"
        , addCmd "new-configure"
        , addCmd "new-repl"
252 253 254
        , addCmd "new-run"
        , addCmd "new-test"
        , addCmd "new-bench"
255 256
        , addCmd "new-freeze"
        , addCmd "new-haddock"
257 258 259
        ] ++ if null otherCmds then [] else par
                                           :startGroup "other"
                                           :[addCmd n | n <- otherCmds])
260 261
      ++ "\n"
      ++ "For more information about a command use:\n"
262 263
      ++ "   " ++ pname ++ " COMMAND --help\n"
      ++ "or " ++ pname ++ " help COMMAND\n"
264
      ++ "\n"
265
      ++ "To install Cabal packages from hackage use:\n"
266 267
      ++ "  " ++ pname ++ " install foo [--dry-run]\n"
      ++ "\n"
268 269
      ++ "Occasionally you need to update the list of available packages:\n"
      ++ "  " ++ pname ++ " update\n",
270
    commandNotes = Nothing,
271
    commandDefaultFlags = mempty,
272 273 274 275 276 277 278 279 280 281 282
    commandOptions = args
  }
  where
    args :: ShowOrParseArgs -> [OptionField GlobalFlags]
    args ShowArgs  = argsShown
    args ParseArgs = argsShown ++ argsNotShown

    -- arguments we want to show in the help
    argsShown :: [OptionField GlobalFlags]
    argsShown = [
       option ['V'] ["version"]
283 284 285 286 287 288 289 290 291 292 293 294 295 296
         "Print version information"
         globalVersion (\v flags -> flags { globalVersion = v })
         trueArg

      ,option [] ["numeric-version"]
         "Print just the version number"
         globalNumericVersion (\v flags -> flags { globalNumericVersion = v })
         trueArg

      ,option [] ["config-file"]
         "Set an alternate location for the config file"
         globalConfigFile (\v flags -> flags { globalConfigFile = v })
         (reqArgFlag "FILE")

297
      ,option [] ["sandbox-config-file"]
298
         "Set an alternate location for the sandbox config file (default: './cabal.sandbox.config')"
299
         globalSandboxConfigFile (\v flags -> flags { globalSandboxConfigFile = v })
300 301
         (reqArgFlag "FILE")

U-CIQDEV\gbazerman's avatar
U-CIQDEV\gbazerman committed
302 303
      ,option [] ["default-user-config"]
         "Set a location for a cabal.config file for projects without their own cabal.config freeze file."
304
         globalConstraintsFile (\v flags -> flags {globalConstraintsFile = v})
U-CIQDEV\gbazerman's avatar
U-CIQDEV\gbazerman committed
305 306
         (reqArgFlag "FILE")

307
      ,option [] ["require-sandbox"]
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
308
         "requiring the presence of a sandbox for sandbox-aware commands"
309 310 311
         globalRequireSandbox (\v flags -> flags { globalRequireSandbox = v })
         (boolOpt' ([], ["require-sandbox"]) ([], ["no-require-sandbox"]))

312 313 314 315 316
      ,option [] ["ignore-sandbox"]
         "Ignore any existing sandbox"
         globalIgnoreSandbox (\v flags -> flags { globalIgnoreSandbox = v })
         trueArg

317
      ,option [] ["ignore-expiry"]
Edsko de Vries's avatar
Edsko de Vries committed
318
         "Ignore expiry dates on signed metadata (use only in exceptional circumstances)"
319 320 321
         globalIgnoreExpiry (\v flags -> flags { globalIgnoreExpiry = v })
         trueArg

322
      ,option [] ["http-transport"]
323
         "Set a transport for http(s) requests. Accepts 'curl', 'wget', 'powershell', and 'plain-http'. (default: 'curl')"
324
         globalHttpTransport (\v flags -> flags { globalHttpTransport = v })
325
         (reqArgFlag "HttpTransport")
ttuegel's avatar
ttuegel committed
326 327 328 329
      ,option [] ["nix"]
         "Nix integration: run commands through nix-shell if a 'shell.nix' file exists"
         globalNix (\v flags -> flags { globalNix = v })
         (boolOpt [] [])
330
      ]
331

332 333 334 335
    -- arguments we don't want shown in the help
    argsNotShown :: [OptionField GlobalFlags]
    argsNotShown = [
       option [] ["remote-repo"]
336 337
         "The name and url for a remote repository"
         globalRemoteRepos (\v flags -> flags { globalRemoteRepos = v })
338
         (reqArg' "NAME:URL" (toNubList . maybeToList . readRepo) (map showRepo . fromNubList))
339 340 341 342 343 344 345 346 347

      ,option [] ["remote-repo-cache"]
         "The location where downloads from all remote repos are cached"
         globalCacheDir (\v flags -> flags { globalCacheDir = v })
         (reqArgFlag "DIR")

      ,option [] ["local-repo"]
         "The location of a local repository"
         globalLocalRepos (\v flags -> flags { globalLocalRepos = v })
348
         (reqArg' "DIR" (\x -> toNubList [x]) fromNubList)
349

350 351 352 353 354
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

355 356 357 358
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
359 360 361 362 363
      ]

-- ------------------------------------------------------------
-- * Config flags
-- ------------------------------------------------------------
Duncan Coutts's avatar
Duncan Coutts committed
364

365
configureCommand :: CommandUI ConfigFlags
366 367
configureCommand = c
  { commandDefaultFlags = mempty
368 369 370
  , commandNotes = Just $ \pname -> (case commandNotes c of
         Nothing -> ""
         Just n  -> n pname ++ "\n")
371 372 373 374 375 376
       ++ "Examples:\n"
       ++ "  " ++ pname ++ " configure\n"
       ++ "    Configure with defaults;\n"
       ++ "  " ++ pname ++ " configure --enable-tests -fcustomflag\n"
       ++ "    Configure building package including tests,\n"
       ++ "    with some package-specific flag.\n"
Duncan Coutts's avatar
Duncan Coutts committed
377
  }
378
 where
379
  c = Cabal.configureCommand defaultProgramDb
Duncan Coutts's avatar
Duncan Coutts committed
380

381 382 383
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

384 385 386 387 388 389 390 391
-- | Given some 'ConfigFlags' for the version of Cabal that
-- cabal-install was built with, and a target older 'Version' of
-- Cabal that we want to pass these flags to, convert the
-- flags into a form that will be accepted by the older
-- Setup script.  Generally speaking, this just means filtering
-- out flags that the old Cabal library doesn't understand, but
-- in some cases it may also mean "emulating" a feature using
-- some more legacy flags.
392
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
393
filterConfigureFlags flags cabalLibVersion
394 395
  -- NB: we expect the latest version to be the most common case,
  -- so test it first.
Christiaan Baaij's avatar
Christiaan Baaij committed
396
  | cabalLibVersion >= mkVersion [1,25,0] = flags_latest
397 398 399 400 401
  -- The naming convention is that flags_version gives flags with
  -- all flags *introduced* in version eliminated.
  -- It is NOT the latest version of Cabal library that
  -- these flags work for; version of introduction is a more
  -- natural metric.
402 403 404 405 406 407 408 409 410 411
  | cabalLibVersion < mkVersion [1,3,10] = flags_1_3_10
  | cabalLibVersion < mkVersion [1,10,0] = flags_1_10_0
  | cabalLibVersion < mkVersion [1,12,0] = flags_1_12_0
  | cabalLibVersion < mkVersion [1,14,0] = flags_1_14_0
  | cabalLibVersion < mkVersion [1,18,0] = flags_1_18_0
  | cabalLibVersion < mkVersion [1,19,1] = flags_1_19_1
  | cabalLibVersion < mkVersion [1,19,2] = flags_1_19_2
  | cabalLibVersion < mkVersion [1,21,1] = flags_1_21_1
  | cabalLibVersion < mkVersion [1,22,0] = flags_1_22_0
  | cabalLibVersion < mkVersion [1,23,0] = flags_1_23_0
Christiaan Baaij's avatar
Christiaan Baaij committed
412
  | cabalLibVersion < mkVersion [1,25,0] = flags_1_25_0
413
  | otherwise = flags_latest
414
  where
415 416 417
    flags_latest = flags        {
      -- Cabal >= 1.19.1 uses '--dependency' and does not need '--constraint'.
      configConstraints = [],
418
      -- Passing '--allow-{older,newer}' to Setup.hs is unnecessary, we use
419
      -- '--exact-configuration' instead.
420
      configAllowOlder  = Just (Cabal.AllowOlder Cabal.RelaxDepsNone),
421
      configAllowNewer  = Just (Cabal.AllowNewer Cabal.RelaxDepsNone)
422
      }
423

424 425 426 427
    flags_1_25_0 = flags_latest {
      -- Cabal < 1.25.0 doesn't know about --dynlibdir.
      configInstallDirs = configInstallDirs_1_25_0,
      -- Cabal < 1.25 doesn't have extended verbosity syntax
428 429 430
      configVerbosity   = fmap verboseNoFlags (configVerbosity flags_latest),
      -- Cabal < 1.25 doesn't support --deterministic
      configDeterministic = mempty
431
      }
Christiaan Baaij's avatar
Christiaan Baaij committed
432 433
    configInstallDirs_1_25_0 = (configInstallDirs flags) { dynlibdir = NoFlag }

434
    -- Cabal < 1.23 doesn't know about '--profiling-detail'.
435 436 437
    -- Cabal < 1.23 has a hacked up version of 'enable-profiling'
    -- which we shouldn't use.
    (tryLibProfiling, tryExeProfiling) = computeEffectiveProfiling flags
Christiaan Baaij's avatar
Christiaan Baaij committed
438
    flags_1_23_0 = flags_1_25_0 { configProfDetail    = NoFlag
439
                                , configProfLibDetail = NoFlag
440
                                , configIPID          = NoFlag
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
441 442 443
                                , configProf          = NoFlag
                                , configProfExe       = Flag tryExeProfiling
                                , configProfLib       = Flag tryLibProfiling
444
                                }
445

446
    -- Cabal < 1.22 doesn't know about '--disable-debug-info'.
447
    flags_1_22_0 = flags_1_23_0 { configDebugInfo = NoFlag }
448

449
    -- Cabal < 1.21.1 doesn't know about 'disable-relocatable'
450
    -- Cabal < 1.21.1 doesn't know about 'enable-profiling'
451
    -- (but we already dealt with it in flags_1_23_0)
452 453
    flags_1_21_1 =
      flags_1_22_0 { configRelocatable = NoFlag
454 455
                   , configCoverage = NoFlag
                   , configLibCoverage = configCoverage flags
456
                   }
457 458
    -- Cabal < 1.19.2 doesn't know about '--exact-configuration' and
    -- '--enable-library-stripping'.
459
    flags_1_19_2 = flags_1_21_1 { configExactConfiguration = NoFlag
460
                                , configStripLibs = NoFlag }
461
    -- Cabal < 1.19.1 uses '--constraint' instead of '--dependency'.
462
    flags_1_19_1 = flags_1_19_2 { configDependencies = []
463
                                , configConstraints  = configConstraints flags }
464
    -- Cabal < 1.18.0 doesn't know about --extra-prog-path and --sysconfdir.
465
    flags_1_18_0 = flags_1_19_1 { configProgramPathExtra = toNubList []
466
                                , configInstallDirs = configInstallDirs_1_18_0}
Christiaan Baaij's avatar
Christiaan Baaij committed
467
    configInstallDirs_1_18_0 = (configInstallDirs flags_1_19_1) { sysconfdir = NoFlag }
468
    -- Cabal < 1.14.0 doesn't know about '--disable-benchmarks'.
469
    flags_1_14_0 = flags_1_18_0 { configBenchmarks  = NoFlag }
470 471 472 473
    -- Cabal < 1.12.0 doesn't know about '--enable/disable-executable-dynamic'
    -- and '--enable/disable-library-coverage'.
    flags_1_12_0 = flags_1_14_0 { configLibCoverage = NoFlag
                                , configDynExe      = NoFlag }
474
    -- Cabal < 1.10.0 doesn't know about '--disable-tests'.
475
    flags_1_10_0 = flags_1_12_0 { configTests       = NoFlag }
476
    -- Cabal < 1.3.10 does not grok the '--constraints' flag.
477
    flags_1_3_10 = flags_1_10_0 { configConstraints = [] }
478

479 480
-- | Get the package database settings from 'ConfigFlags', accounting for
-- @--package-db@ and @--user@ flags.
481 482 483 484 485 486
configPackageDB' :: ConfigFlags -> PackageDBStack
configPackageDB' cfg =
    interpretPackageDbFlags userInstall (configPackageDBs cfg)
  where
    userInstall = Cabal.fromFlagOrDefault True (configUserInstall cfg)

487
-- | Configure the compiler, but reduce verbosity during this step.
488 489 490 491 492 493
configCompilerAux' :: ConfigFlags -> IO (Compiler, Platform, ProgramDb)
configCompilerAux' configFlags =
  configCompilerAuxEx configFlags
    --FIXME: make configCompilerAux use a sensible verbosity
    { configVerbosity = fmap lessVerbose (configVerbosity configFlags) }

494 495 496 497 498 499 500 501
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
502
    configExConstraints:: [(UserConstraint, ConstraintSource)],
503
    configPreferences  :: [Dependency],
504
    configSolver       :: Flag PreSolver
505
  }
506
  deriving (Eq, Generic)
507 508

defaultConfigExFlags :: ConfigExFlags
509
defaultConfigExFlags = mempty { configSolver     = Flag defaultSolver }
510 511 512 513 514

configureExCommand :: CommandUI (ConfigFlags, ConfigExFlags)
configureExCommand = configureCommand {
    commandDefaultFlags = (mempty, defaultConfigExFlags),
    commandOptions      = \showOrParseArgs ->
515
         liftOptions fst setFst
516
         (filter ((`notElem` ["constraint", "dependency", "exact-configuration"])
517
                  . optionName) $ configureOptions  showOrParseArgs)
518 519
      ++ liftOptions snd setSnd
         (configureExOptions showOrParseArgs ConstraintSourceCommandlineFlag)
520 521 522 523 524
  }
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

525 526 527 528
configureExOptions :: ShowOrParseArgs
                   -> ConstraintSource
                   -> [OptionField ConfigExFlags]
configureExOptions _showOrParseArgs src =
529 530 531 532 533 534 535
  [ option [] ["cabal-lib-version"]
      ("Select which version of the Cabal lib to use to build packages "
      ++ "(useful for testing).")
      configCabalVersion (\v flags -> flags { configCabalVersion = v })
      (reqArg "VERSION" (readP_to_E ("Cannot parse cabal lib version: "++)
                                    (fmap toFlag parse))
                        (map display . flagToList))
536 537 538 539
  , option [] ["constraint"]
      "Specify constraints on a package (version, installed/source, flags)"
      configExConstraints (\v flags -> flags { configExConstraints = v })
      (reqArg "CONSTRAINT"
540 541
              ((\x -> [(x, src)]) `fmap` ReadE readUserConstraint)
              (map $ display . fst))
542 543 544 545

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
546 547 548 549
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
550 551

  , optionSolver configSolver (\v flags -> flags { configSolver = v })
552

553 554 555
  ]

instance Monoid ConfigExFlags where
556
  mempty = gmempty
557 558 559
  mappend = (<>)

instance Semigroup ConfigExFlags where
560
  (<>) = gmappend
561

ttuegel's avatar
ttuegel committed
562 563 564 565 566 567
reconfigureCommand :: CommandUI (ConfigFlags, ConfigExFlags)
reconfigureCommand
  = configureExCommand
    { commandName         = "reconfigure"
    , commandSynopsis     = "Reconfigure the package if necessary."
    , commandDescription  = Just $ \pname -> wrapText $
568 569
         "Run `configure` with the most recently used flags, or append FLAGS "
         ++ "to the most recently used configuration. "
ttuegel's avatar
ttuegel committed
570
         ++ "Accepts the same flags as `" ++ pname ++ " configure'. "
571 572 573 574 575 576 577 578 579
         ++ "If the package has never been configured, the default flags are "
         ++ "used."
    , commandNotes        = Just $ \pname ->
        "Examples:\n"
        ++ "  " ++ pname ++ " reconfigure\n"
        ++ "    Configure with the most recently used flags.\n"
        ++ "  " ++ pname ++ " reconfigure -w PATH\n"
        ++ "    Reconfigure with the most recently used flags,\n"
        ++ "    but use the compiler at PATH.\n\n"
ttuegel's avatar
ttuegel committed
580 581 582 583
    , commandUsage        = usageAlternatives "reconfigure" [ "[FLAGS]" ]
    , commandDefaultFlags = mempty
    }

ttuegel's avatar
ttuegel committed
584 585 586 587
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

588 589 590 591 592 593
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
594
} deriving Generic
595 596 597

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
598
  option [] ["only"]
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
  "Don't reinstall add-source dependencies (sandbox-only)"
  buildOnly (\v flags -> flags { buildOnly = v })
  (noArg (Flag SkipAddSourceDepsCheck))

  : []

buildCommand :: CommandUI (BuildFlags, BuildExFlags)
buildCommand = parent {
    commandDefaultFlags = (commandDefaultFlags parent, mempty),
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
                          (commandOptions parent showOrParseArgs)
                          ++
                          liftOptions snd setSnd (buildExOptions showOrParseArgs)
  }
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

618
    parent = Cabal.buildCommand defaultProgramDb
619 620

instance Monoid BuildExFlags where
621
  mempty = gmempty
622 623 624
  mappend = (<>)

instance Semigroup BuildExFlags where
625
  (<>) = gmappend
626 627

-- ------------------------------------------------------------
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
-- * Repl command
-- ------------------------------------------------------------

replCommand :: CommandUI (ReplFlags, BuildExFlags)
replCommand = parent {
    commandDefaultFlags = (commandDefaultFlags parent, mempty),
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
                          (commandOptions parent showOrParseArgs)
                          ++
                          liftOptions snd setSnd (buildExOptions showOrParseArgs)
  }
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

644
    parent = Cabal.replCommand defaultProgramDb
645

646 647 648 649
-- ------------------------------------------------------------
-- * Test command
-- ------------------------------------------------------------

650
testCommand :: CommandUI (TestFlags, BuildFlags, BuildExFlags)
651
testCommand = parent {
652 653
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
654
  commandOptions      =
655
    \showOrParseArgs -> liftOptions get1 set1
656 657
                        (commandOptions parent showOrParseArgs)
                        ++
658
                        liftOptions get2 set2
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
659
                        (Cabal.buildOptions progDb showOrParseArgs)
660 661
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
662 663
  }
  where
664 665 666
    get1 (a,_,_) = a; set1 a (_,b,c) = (a,b,c)
    get2 (_,b,_) = b; set2 b (a,_,c) = (a,b,c)
    get3 (_,_,c) = c; set3 c (a,b,_) = (a,b,c)
667

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
668 669
    parent = Cabal.testCommand
    progDb = defaultProgramDb
670 671 672 673 674

-- ------------------------------------------------------------
-- * Bench command
-- ------------------------------------------------------------

675
benchmarkCommand :: CommandUI (BenchmarkFlags, BuildFlags, BuildExFlags)
676
benchmarkCommand = parent {
677 678
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
679
  commandOptions      =
680
    \showOrParseArgs -> liftOptions get1 set1
681 682
                        (commandOptions parent showOrParseArgs)
                        ++
683
                        liftOptions get2 set2
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
684
                        (Cabal.buildOptions progDb showOrParseArgs)
685 686
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
ttuegel's avatar
ttuegel committed
687
  }
688
  where
689 690 691
    get1 (a,_,_) = a; set1 a (_,b,c) = (a,b,c)
    get2 (_,b,_) = b; set2 b (a,_,c) = (a,b,c)
    get3 (_,_,c) = c; set3 c (a,b,_) = (a,b,c)
692

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
693 694
    parent = Cabal.benchmarkCommand
    progDb = defaultProgramDb
ttuegel's avatar
ttuegel committed
695

696
-- ------------------------------------------------------------
697
-- * Fetch command
698
-- ------------------------------------------------------------
699

700 701 702 703
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
704
      fetchSolver           :: Flag PreSolver,
705
      fetchMaxBackjumps     :: Flag Int,
706
      fetchReorderGoals     :: Flag ReorderGoals,
707
      fetchCountConflicts   :: Flag CountConflicts,
708 709 710
      fetchIndependentGoals :: Flag IndependentGoals,
      fetchShadowPkgs       :: Flag ShadowPkgs,
      fetchStrongFlags      :: Flag StrongFlags,
711
      fetchAllowBootLibInstalls :: Flag AllowBootLibInstalls,
712 713 714 715 716 717 718 719
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
720 721
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
722
    fetchReorderGoals     = Flag (ReorderGoals False),
723
    fetchCountConflicts   = Flag (CountConflicts True),
724 725 726
    fetchIndependentGoals = Flag (IndependentGoals False),
    fetchShadowPkgs       = Flag (ShadowPkgs False),
    fetchStrongFlags      = Flag (StrongFlags False),
727
    fetchAllowBootLibInstalls = Flag (AllowBootLibInstalls False),
728 729 730 731
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
732 733
fetchCommand = CommandUI {
    commandName         = "fetch",
734
    commandSynopsis     = "Downloads packages for later installation.",
735 736 737 738 739
    commandUsage        = usageAlternatives "fetch" [ "[FLAGS] PACKAGES"
                                                    ],
    commandDescription  = Just $ \_ ->
          "Note that it currently is not possible to fetch the dependencies for a\n"
       ++ "package in the current directory.\n",
740
    commandNotes        = Nothing,
741
    commandDefaultFlags = defaultFetchFlags,
742
    commandOptions      = \ showOrParseArgs -> [
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
         optionVerbosity fetchVerbosity (\v flags -> flags { fetchVerbosity = v })

--     , option "o" ["output"]
--         "Put the package(s) somewhere specific rather than the usual cache."
--         fetchOutput (\v flags -> flags { fetchOutput = v })
--         (reqArgFlag "PATH")

       , option [] ["dependencies", "deps"]
           "Resolve and fetch dependencies (default)"
           fetchDeps (\v flags -> flags { fetchDeps = v })
           trueArg

       , option [] ["no-dependencies", "no-deps"]
           "Ignore dependencies"
           fetchDeps (\v flags -> flags { fetchDeps = v })
           falseArg

       , option [] ["dry-run"]
           "Do not install anything, only print what would be installed."
           fetchDryRun (\v flags -> flags { fetchDryRun = v })
           trueArg
764 765 766 767

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
768 769
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
770
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
771
                         fetchCountConflicts   (\v flags -> flags { fetchCountConflicts   = v })
772
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
773
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
Andres Löh's avatar
Andres Löh committed
774
                         fetchStrongFlags      (\v flags -> flags { fetchStrongFlags      = v })
775
                         fetchAllowBootLibInstalls (\v flags -> flags { fetchAllowBootLibInstalls = v })
776

Duncan Coutts's avatar
Duncan Coutts committed
777 778
  }

779 780 781 782 783 784
-- ------------------------------------------------------------
-- * Freeze command
-- ------------------------------------------------------------

data FreezeFlags = FreezeFlags {
      freezeDryRun           :: Flag Bool,
785 786
      freezeTests            :: Flag Bool,
      freezeBenchmarks       :: Flag Bool,
787 788
      freezeSolver           :: Flag PreSolver,
      freezeMaxBackjumps     :: Flag Int,
789
      freezeReorderGoals     :: Flag ReorderGoals,
790
      freezeCountConflicts   :: Flag CountConflicts,
791 792 793
      freezeIndependentGoals :: Flag IndependentGoals,
      freezeShadowPkgs       :: Flag ShadowPkgs,
      freezeStrongFlags      :: Flag StrongFlags,
794
      freezeAllowBootLibInstalls :: Flag AllowBootLibInstalls,
795 796 797 798 799 800
      freezeVerbosity        :: Flag Verbosity
    }

defaultFreezeFlags :: FreezeFlags
defaultFreezeFlags = FreezeFlags {
    freezeDryRun           = toFlag False,
801 802
    freezeTests            = toFlag False,
    freezeBenchmarks       = toFlag False,
803 804
    freezeSolver           = Flag defaultSolver,
    freezeMaxBackjumps     = Flag defaultMaxBackjumps,
805
    freezeReorderGoals     = Flag (ReorderGoals False),
806
    freezeCountConflicts   = Flag (CountConflicts True),
807 808 809
    freezeIndependentGoals = Flag (IndependentGoals False),
    freezeShadowPkgs       = Flag (ShadowPkgs False),
    freezeStrongFlags      = Flag (StrongFlags False),
810
    freezeAllowBootLibInstalls = Flag (AllowBootLibInstalls False),
811 812 813 814 815 816 817
    freezeVerbosity        = toFlag normal
   }

freezeCommand :: CommandUI FreezeFlags
freezeCommand = CommandUI {
    commandName         = "freeze",
    commandSynopsis     = "Freeze dependencies.",
818 819 820 821 822 823 824 825
    commandDescription  = Just $ \_ -> wrapText $
         "Calculates a valid set of dependencies and their exact versions. "
      ++ "If successful, saves the result to the file `cabal.config`.\n"
      ++ "\n"
      ++ "The package versions specified in `cabal.config` will be used for "
      ++ "any future installs.\n"
      ++ "\n"
      ++ "An existing `cabal.config` is ignored and overwritten.\n",
826
    commandNotes        = Nothing,
827
    commandUsage        = usageFlags "freeze",
828 829
    commandDefaultFlags = defaultFreezeFlags,
    commandOptions      = \ showOrParseArgs -> [
830 831
         optionVerbosity freezeVerbosity
         (\v flags -> flags { freezeVerbosity = v })
832 833 834 835 836 837

       , option [] ["dry-run"]
           "Do not freeze anything, only print what would be frozen"
           freezeDryRun (\v flags -> flags { freezeDryRun = v })
           trueArg

838
       , option [] ["tests"]
839 840
           ("freezing of the dependencies of any tests suites "
            ++ "in the package description file.")
841 842 843 844
           freezeTests (\v flags -> flags { freezeTests = v })
           (boolOpt [] [])

       , option [] ["benchmarks"]
845 846
           ("freezing of the dependencies of any benchmarks suites "
            ++ "in the package description file.")
847 848 849
           freezeBenchmarks (\v flags -> flags { freezeBenchmarks = v })
           (boolOpt [] [])

850 851
       ] ++

852 853
       optionSolver
         freezeSolver           (\v flags -> flags { freezeSolver           = v }):
854 855 856
       optionSolverFlags showOrParseArgs
                         freezeMaxBackjumps     (\v flags -> flags { freezeMaxBackjumps     = v })
                         freezeReorderGoals     (\v flags -> flags { freezeReorderGoals     = v })
857
                         freezeCountConflicts   (\v flags -> flags { freezeCountConflicts   = v })
858 859
                         freezeIndependentGoals (\v flags -> flags { freezeIndependentGoals = v })
                         freezeShadowPkgs       (\v flags -> flags { freezeShadowPkgs       = v })
Andres Löh's avatar
Andres Löh committed
860
                         freezeStrongFlags      (\v flags -> flags { freezeStrongFlags      = v })
861
                         freezeAllowBootLibInstalls (\v flags -> flags { freezeAllowBootLibInstalls = v })
862 863 864

  }

865 866 867 868
-- ------------------------------------------------------------
-- * 'gen-bounds' command
-- ------------------------------------------------------------

869 870 871 872 873 874
genBoundsCommand :: CommandUI FreezeFlags
genBoundsCommand = CommandUI {
    commandName         = "gen-bounds",
    commandSynopsis     = "Generate dependency bounds.",
    commandDescription  = Just $ \_ -> wrapText $
         "Generates bounds for all dependencies that do not currently have them. "