Setup.hs 59.3 KB
Newer Older
1 2
-----------------------------------------------------------------------------
-- |
3
-- Module      :  Distribution.Client.Setup
4 5 6 7 8 9 10 11 12
-- Copyright   :  (c) David Himmelstrup 2005
-- License     :  BSD-like
--
-- Maintainer  :  lemmih@gmail.com
-- Stability   :  provisional
-- Portability :  portable
--
--
-----------------------------------------------------------------------------
13
module Distribution.Client.Setup
14
    ( globalCommand, GlobalFlags(..), globalRepos
15
    , configureCommand, ConfigFlags(..), filterConfigureFlags
16 17
    , configureExCommand, ConfigExFlags(..), defaultConfigExFlags
                        , configureExOptions
18 19
    , buildCommand, BuildFlags(..), BuildExFlags(..), SkipAddSourceDepsCheck(..)
    , testCommand, benchmarkCommand
20
    , installCommand, InstallFlags(..), installOptions, defaultInstallFlags
21
    , listCommand, ListFlags(..)
Duncan Coutts's avatar
Duncan Coutts committed
22
    , updateCommand
ijones's avatar
ijones committed
23
    , upgradeCommand
24
    , infoCommand, InfoFlags(..)
25
    , fetchCommand, FetchFlags(..)
26
    , getCommand, unpackCommand, GetFlags(..)
27
    , checkCommand
28
    , uploadCommand, UploadFlags(..)
29
    , reportCommand, ReportFlags(..)
refold's avatar
refold committed
30
    , runCommand
31
    , initCommand, IT.InitFlags(..)
32
    , sdistCommand, SDistFlags(..), SDistExFlags(..), ArchiveFormat(..)
33
    , win32SelfUpgradeCommand, Win32SelfUpgradeFlags(..)
refold's avatar
refold committed
34
    , sandboxCommand, defaultSandboxLocation, SandboxFlags(..)
Duncan Coutts's avatar
Duncan Coutts committed
35 36

    , parsePackageArgs
37 38 39
    --TODO: stop exporting these:
    , showRepo
    , parseRepo
40 41
    ) where

42
import Distribution.Client.Types
43
         ( Username(..), Password(..), Repo(..), RemoteRepo(..), LocalRepo(..) )
44 45
import Distribution.Client.BuildReports.Types
         ( ReportLevel(..) )
46
import Distribution.Client.Dependency.Types
47
         ( PreSolver(..) )
48 49
import qualified Distribution.Client.Init.Types as IT
         ( InitFlags(..), PackageType(..) )
50 51
import Distribution.Client.Targets
         ( UserConstraint, readUserConstraint )
52

53
import Distribution.Simple.Compiler (PackageDB)
54 55
import Distribution.Simple.Program
         ( defaultProgramConfiguration )
56
import Distribution.Simple.Command hiding (boolOpt)
Duncan Coutts's avatar
Duncan Coutts committed
57
import qualified Distribution.Simple.Setup as Cabal
58
import Distribution.Simple.Setup
59 60
         ( ConfigFlags(..), BuildFlags(..), TestFlags(..), BenchmarkFlags(..)
         , SDistFlags(..), HaddockFlags(..)
61
         , readPackageDbList, showPackageDbList
62
         , Flag(..), toFlag, fromFlag, flagToMaybe, flagToList
63
         , optionVerbosity, boolOpt, trueArg, falseArg, numJobsParser )
64
import Distribution.Simple.InstallDirs
65 66
         ( PathTemplate, InstallDirs(sysconfdir)
         , toPathTemplate, fromPathTemplate )
67
import Distribution.Version
Duncan Coutts's avatar
Duncan Coutts committed
68
         ( Version(Version), anyVersion, thisVersion )
69
import Distribution.Package
70
         ( PackageIdentifier, packageName, packageVersion, Dependency(..) )
71 72
import Distribution.PackageDescription
         ( RepoKind(..) )
73
import Distribution.Text
74
         ( Text(..), display )
75
import Distribution.ReadE
76
         ( ReadE(..), readP_to_E, succeedReadE )
77
import qualified Distribution.Compat.ReadP as Parse
Andres Löh's avatar
Andres Löh committed
78
         ( ReadP, readP_to_S, readS_to_P, char, munch1, pfail, (+++) )
79 80
import Distribution.Verbosity
         ( Verbosity, normal )
81 82
import Distribution.Simple.Utils
         ( wrapText )
83

84 85
import Data.Char
         ( isSpace, isAlphaNum )
86 87
import Data.List
         ( intercalate )
88
import Data.Maybe
89
         ( listToMaybe, maybeToList, fromMaybe )
90 91 92 93 94 95 96 97
import Data.Monoid
         ( Monoid(..) )
import Control.Monad
         ( liftM )
import System.FilePath
         ( (</>) )
import Network.URI
         ( parseAbsoluteURI, uriToString )
98

99 100 101 102 103 104
-- ------------------------------------------------------------
-- * Global flags
-- ------------------------------------------------------------

-- | Flags that apply at the top level, not to any sub-command.
data GlobalFlags = GlobalFlags {
105 106 107 108 109 110 111 112 113
    globalVersion           :: Flag Bool,
    globalNumericVersion    :: Flag Bool,
    globalConfigFile        :: Flag FilePath,
    globalSandboxConfigFile :: Flag FilePath,
    globalRemoteRepos       :: [RemoteRepo],     -- ^ Available Hackage servers.
    globalCacheDir          :: Flag FilePath,
    globalLocalRepos        :: [FilePath],
    globalLogsDir           :: Flag FilePath,
    globalWorldFile         :: Flag FilePath
114
  }
Duncan Coutts's avatar
Duncan Coutts committed
115

116 117
defaultGlobalFlags :: GlobalFlags
defaultGlobalFlags  = GlobalFlags {
118 119 120 121 122 123 124 125 126
    globalVersion           = Flag False,
    globalNumericVersion    = Flag False,
    globalConfigFile        = mempty,
    globalSandboxConfigFile = mempty,
    globalRemoteRepos       = [],
    globalCacheDir          = mempty,
    globalLocalRepos        = mempty,
    globalLogsDir           = mempty,
    globalWorldFile         = mempty
127 128 129 130 131 132
  }

globalCommand :: CommandUI GlobalFlags
globalCommand = CommandUI {
    commandName         = "",
    commandSynopsis     = "",
133 134 135 136
    commandUsage        = \_ ->
         "This program is the command line interface "
           ++ "to the Haskell Cabal infrastructure.\n"
      ++ "See http://www.haskell.org/cabal/ for more information.\n",
137
    commandDescription  = Just $ \pname ->
138 139 140 141 142 143
         "For more information about a command use:\n"
      ++ "  " ++ pname ++ " COMMAND --help\n\n"
      ++ "To install Cabal packages from hackage use:\n"
      ++ "  " ++ pname ++ " install foo [--dry-run]\n\n"
      ++ "Occasionally you need to update the list of available packages:\n"
      ++ "  " ++ pname ++ " update\n",
144 145
    commandDefaultFlags = defaultGlobalFlags,
    commandOptions      = \showOrParseArgs ->
146
      (case showOrParseArgs of ShowArgs -> take 4; ParseArgs -> id)
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
      [option ['V'] ["version"]
         "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")

162 163 164 165 166 167
      ,option [] ["sandbox-config-file"]
         "Set an alternate location for the sandbox config file \
         \(default: './cabal.sandbox.config')"
         globalConfigFile (\v flags -> flags { globalSandboxConfigFile = v })
         (reqArgFlag "FILE")

168 169 170 171 172 173 174 175 176 177 178 179 180 181
      ,option [] ["remote-repo"]
         "The name and url for a remote repository"
         globalRemoteRepos (\v flags -> flags { globalRemoteRepos = v })
         (reqArg' "NAME:URL" (maybeToList . readRepo) (map showRepo))

      ,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 })
         (reqArg' "DIR" (\x -> [x]) id)
182

183 184 185 186 187
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

188 189 190 191
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
192 193 194 195 196
      ]
  }

instance Monoid GlobalFlags where
  mempty = GlobalFlags {
197 198 199 200 201 202 203 204 205
    globalVersion           = mempty,
    globalNumericVersion    = mempty,
    globalConfigFile        = mempty,
    globalSandboxConfigFile = mempty,
    globalRemoteRepos       = mempty,
    globalCacheDir          = mempty,
    globalLocalRepos        = mempty,
    globalLogsDir           = mempty,
    globalWorldFile         = mempty
206 207
  }
  mappend a b = GlobalFlags {
208 209 210 211 212 213 214 215 216
    globalVersion           = combine globalVersion,
    globalNumericVersion    = combine globalNumericVersion,
    globalConfigFile        = combine globalConfigFile,
    globalSandboxConfigFile = combine globalConfigFile,
    globalRemoteRepos       = combine globalRemoteRepos,
    globalCacheDir          = combine globalCacheDir,
    globalLocalRepos        = combine globalLocalRepos,
    globalLogsDir           = combine globalLogsDir,
    globalWorldFile         = combine globalWorldFile
Duncan Coutts's avatar
Duncan Coutts committed
217
  }
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
    where combine field = field a `mappend` field b

globalRepos :: GlobalFlags -> [Repo]
globalRepos globalFlags = remoteRepos ++ localRepos
  where
    remoteRepos =
      [ Repo (Left remote) cacheDir
      | remote <- globalRemoteRepos globalFlags
      , let cacheDir = fromFlag (globalCacheDir globalFlags)
                   </> remoteRepoName remote ]
    localRepos =
      [ Repo (Right LocalRepo) local
      | local <- globalLocalRepos globalFlags ]

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

236
configureCommand :: CommandUI ConfigFlags
237
configureCommand = (Cabal.configureCommand defaultProgramConfiguration) {
238
    commandDefaultFlags = mempty
Duncan Coutts's avatar
Duncan Coutts committed
239 240
  }

241 242 243
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

244
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
245
filterConfigureFlags flags cabalLibVersion
246
  | cabalLibVersion >= Version [1,19,1] [] = flags_latest
247 248 249
  | cabalLibVersion <  Version [1,3,10] [] = flags_1_3_10
  | cabalLibVersion <  Version [1,10,0] [] = flags_1_10_0
  | cabalLibVersion <  Version [1,14,0] [] = flags_1_14_0
250
  | cabalLibVersion <  Version [1,18,0] [] = flags_1_18_0
251
  | cabalLibVersion <  Version [1,19,1] [] = flags_1_19_0
252
  | otherwise = flags_latest
253
  where
254 255 256
    -- Cabal >= 1.19.1 uses --dependency and does not need --constraint
    flags_latest = flags        { configConstraints = [] }

257
    -- Cabal < 1.19.1 does not grok the --dependency flag.
258
    flags_1_19_0 = flags        { configDependencies = [] }
259
    -- Cabal < 1.18.0 doesn't know about --extra-prog-path and --sysconfdir.
260
    flags_1_18_0 = flags_1_19_0 { configProgramPathExtra = []
261 262
                                , configInstallDirs = configInstallDirs_1_18_0}
    configInstallDirs_1_18_0 = (configInstallDirs flags) { sysconfdir = NoFlag }
263
    -- Cabal < 1.14.0 doesn't know about --disable-benchmarks.
264
    flags_1_14_0 = flags_1_18_0 { configBenchmarks  = NoFlag }
265 266
    -- Cabal < 1.10.0 doesn't know about --disable-tests.
    flags_1_10_0 = flags_1_14_0 { configTests       = NoFlag }
267
    -- Cabal < 1.3.10 does not grok the --constraints flag.
268
    flags_1_3_10 = flags_1_10_0 { configConstraints = [] }
269

270 271 272 273 274 275 276 277
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
278
    configExConstraints:: [UserConstraint],
279
    configPreferences  :: [Dependency],
280
    configSolver       :: Flag PreSolver
281 282 283
  }

defaultConfigExFlags :: ConfigExFlags
284
defaultConfigExFlags = mempty { configSolver = Flag defaultSolver }
285 286 287 288 289

configureExCommand :: CommandUI (ConfigFlags, ConfigExFlags)
configureExCommand = configureCommand {
    commandDefaultFlags = (mempty, defaultConfigExFlags),
    commandOptions      = \showOrParseArgs ->
290 291
         liftOptions fst setFst (filter ((/="constraint") . optionName) $
                                 configureOptions   showOrParseArgs)
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
      ++ liftOptions snd setSnd (configureExOptions showOrParseArgs)
  }
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

configureExOptions ::  ShowOrParseArgs -> [OptionField ConfigExFlags]
configureExOptions _showOrParseArgs =
  [ 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))
307 308 309 310 311 312
  , option [] ["constraint"]
      "Specify constraints on a package (version, installed/source, flags)"
      configExConstraints (\v flags -> flags { configExConstraints = v })
      (reqArg "CONSTRAINT"
              (fmap (\x -> [x]) (ReadE readUserConstraint))
              (map display))
313 314 315 316

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
317 318 319 320
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
321 322

  , optionSolver configSolver (\v flags -> flags { configSolver = v })
323 324 325 326 327
  ]

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
328
    configExConstraints= mempty,
329 330
    configPreferences  = mempty,
    configSolver       = mempty
331 332 333
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
334
    configExConstraints= combine configExConstraints,
335 336
    configPreferences  = combine configPreferences,
    configSolver       = combine configSolver
337 338 339
  }
    where combine field = field a `mappend` field b

ttuegel's avatar
ttuegel committed
340 341 342 343
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

344 345 346 347 348 349 350 351 352 353
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
}

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
354
  option [] ["only"]
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
  "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)

    parent = Cabal.buildCommand defaultProgramConfiguration

instance Monoid BuildExFlags where
  mempty = BuildExFlags {
    buildOnly    = mempty
  }
  mappend a b = BuildExFlags {
    buildOnly    = combine buildOnly
  }
    where combine field = field a `mappend` field b

-- ------------------------------------------------------------
-- * Test command
-- ------------------------------------------------------------

389
testCommand :: CommandUI (TestFlags, BuildFlags, BuildExFlags)
390
testCommand = parent {
391 392
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
393
  commandOptions      =
394
    \showOrParseArgs -> liftOptions get1 set1
395 396
                        (commandOptions parent showOrParseArgs)
                        ++
397 398 399 400
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
401 402
  }
  where
403 404 405
    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)
406

407 408
    parent   = Cabal.testCommand
    progConf = defaultProgramConfiguration
409 410 411 412 413

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

414
benchmarkCommand :: CommandUI (BenchmarkFlags, BuildFlags, BuildExFlags)
415
benchmarkCommand = parent {
416 417
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
418
  commandOptions      =
419
    \showOrParseArgs -> liftOptions get1 set1
420 421
                        (commandOptions parent showOrParseArgs)
                        ++
422 423 424 425
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
ttuegel's avatar
ttuegel committed
426
  }
427
  where
428 429 430
    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)
431

432 433
    parent   = Cabal.benchmarkCommand
    progConf = defaultProgramConfiguration
ttuegel's avatar
ttuegel committed
434

435
-- ------------------------------------------------------------
436
-- * Fetch command
437
-- ------------------------------------------------------------
438

439 440 441 442
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
443
      fetchSolver           :: Flag PreSolver,
444 445 446
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
447
      fetchShadowPkgs       :: Flag Bool,
448 449 450 451 452 453 454 455
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
456 457 458 459
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
    fetchReorderGoals     = Flag False,
    fetchIndependentGoals = Flag False,
460
    fetchShadowPkgs       = Flag False,
461 462 463 464
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
465 466
fetchCommand = CommandUI {
    commandName         = "fetch",
467
    commandSynopsis     = "Downloads packages for later installation.",
Duncan Coutts's avatar
Duncan Coutts committed
468
    commandDescription  = Nothing,
refold's avatar
refold committed
469
    commandUsage        = usagePackages "fetch",
470
    commandDefaultFlags = defaultFetchFlags,
471
    commandOptions      = \ showOrParseArgs -> [
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
         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
493 494 495 496

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
497 498
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
499 500
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
501
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
502

Duncan Coutts's avatar
Duncan Coutts committed
503 504
  }

505 506 507 508
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

509
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
510 511
updateCommand = CommandUI {
    commandName         = "update",
512
    commandSynopsis     = "Updates list of known packages.",
Duncan Coutts's avatar
Duncan Coutts committed
513
    commandDescription  = Nothing,
refold's avatar
refold committed
514
    commandUsage        = usageFlags "update",
515
    commandDefaultFlags = toFlag normal,
516
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
517 518
  }

519
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
520
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
521
    commandName         = "upgrade",
522
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
523
    commandDescription  = Nothing,
refold's avatar
refold committed
524
    commandUsage        = usageFlagsOrPackages "upgrade",
525
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
526
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
527 528
  }

Duncan Coutts's avatar
Duncan Coutts committed
529 530 531 532 533 534 535 536 537 538 539
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

540 541 542
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
543
    commandSynopsis     = "Check the package for common mistakes.",
544 545
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
546
    commandDefaultFlags = toFlag normal,
547
    commandOptions      = \_ -> []
548 549
  }

550
runCommand :: CommandUI (BuildFlags, BuildExFlags)
refold's avatar
refold committed
551 552 553 554 555
runCommand = CommandUI {
    commandName         = "run",
    commandSynopsis     = "Runs the compiled executable.",
    commandDescription  = Nothing,
    commandUsage        =
556 557 558
      \pname -> "Usage: " ++ pname
                ++ " run [FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]\n\n"
                ++ "Flags for run:",
refold's avatar
refold committed
559
    commandDefaultFlags = mempty,
560 561 562 563 564 565
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
                          (Cabal.buildOptions progConf showOrParseArgs)
                          ++
                          liftOptions snd setSnd
                          (buildExOptions showOrParseArgs)
refold's avatar
refold committed
566 567
  }
  where
568 569 570
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

refold's avatar
refold committed
571 572
    progConf = defaultProgramConfiguration

573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
-- ------------------------------------------------------------
-- * Report flags
-- ------------------------------------------------------------

data ReportFlags = ReportFlags {
    reportUsername  :: Flag Username,
    reportPassword  :: Flag Password,
    reportVerbosity :: Flag Verbosity
  }

defaultReportFlags :: ReportFlags
defaultReportFlags = ReportFlags {
    reportUsername  = mempty,
    reportPassword  = mempty,
    reportVerbosity = toFlag normal
  }

reportCommand :: CommandUI ReportFlags
591 592 593
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
    commandDescription  = Just $ \_ ->
         "You can store your Hackage login in the ~/.cabal/config file\n",
    commandUsage        = \pname -> "Usage: " ++ pname ++ " report [FLAGS]\n\n"
      ++ "Flags for upload:",
    commandDefaultFlags = defaultReportFlags,
    commandOptions      = \_ ->
      [optionVerbosity reportVerbosity (\v flags -> flags { reportVerbosity = v })

      ,option ['u'] ["username"]
        "Hackage username."
        reportUsername (\v flags -> flags { reportUsername = v })
        (reqArg' "USERNAME" (toFlag . Username)
                            (flagToList . fmap unUsername))

      ,option ['p'] ["password"]
        "Hackage password."
        reportPassword (\v flags -> flags { reportPassword = v })
        (reqArg' "PASSWORD" (toFlag . Password)
                            (flagToList . fmap unPassword))
      ]
614 615
  }

616 617 618 619 620 621 622 623 624 625 626 627 628
instance Monoid ReportFlags where
  mempty = ReportFlags {
    reportUsername  = mempty,
    reportPassword  = mempty,
    reportVerbosity = mempty
  }
  mappend a b = ReportFlags {
    reportUsername  = combine reportUsername,
    reportPassword  = combine reportPassword,
    reportVerbosity = combine reportVerbosity
  }
    where combine field = field a `mappend` field b

629
-- ------------------------------------------------------------
630
-- * Get flags
631 632
-- ------------------------------------------------------------

633 634 635 636 637 638
data GetFlags = GetFlags {
    getDestDir          :: Flag FilePath,
    getPristine         :: Flag Bool,
    getSourceRepository :: Flag (Maybe RepoKind),
    getVerbosity        :: Flag Verbosity
  }
639

640 641 642 643 644 645
defaultGetFlags :: GetFlags
defaultGetFlags = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = toFlag normal
646 647
   }

648 649 650 651
getCommand :: CommandUI GetFlags
getCommand = CommandUI {
    commandName         = "get",
    commandSynopsis     = "Gets a package's source code.",
652 653 654 655 656
    commandDescription  = Just $ \_ ->
          "Creates a local copy of a package's source code. By default it gets "
       ++ "the source\ntarball and unpacks it in a local subdirectory. "
       ++ "Alternatively, with -s it will\nget the code from the source "
       ++ "repository specified by the package.\n",
657
    commandUsage        = usagePackages "get",
658 659
    commandDefaultFlags = mempty,
    commandOptions      = \_ -> [
660
        optionVerbosity getVerbosity (\v flags -> flags { getVerbosity = v })
661 662

       ,option "d" ["destdir"]
refold's avatar
refold committed
663
         "Where to place the package source, defaults to the current directory."
664
         getDestDir (\v flags -> flags { getDestDir = v })
665
         (reqArgFlag "PATH")
666

667
       ,option "s" ["source-repository"]
668
         "Copy the package's source repository (ie git clone, darcs get, etc as appropriate)."
669 670 671 672 673 674
         getSourceRepository (\v flags -> flags { getSourceRepository = v })
        (optArg "[head|this|...]" (readP_to_E (const "invalid source-repository")
                                              (fmap (toFlag . Just) parse))
                                  (Flag Nothing)
                                  (map (fmap show) . flagToList))

675 676 677
       , option [] ["pristine"]
           ("Unpack the original pristine tarball, rather than updating the "
           ++ ".cabal file with the latest revision from the package archive.")
678
           getPristine (\v flags -> flags { getPristine = v })
679
           trueArg
680 681 682
       ]
  }

683 684 685 686 687 688 689
-- 'cabal unpack' is a deprecated alias for 'cabal get'.
unpackCommand :: CommandUI GetFlags
unpackCommand = getCommand {
  commandName  = "unpack",
  commandUsage = usagePackages "unpack"
  }

690 691 692 693 694 695 696
instance Monoid GetFlags where
  mempty = defaultGetFlags
  mappend a b = GetFlags {
    getDestDir          = combine getDestDir,
    getPristine         = combine getPristine,
    getSourceRepository = combine getSourceRepository,
    getVerbosity        = combine getVerbosity
697 698 699
  }
    where combine field = field a `mappend` field b

700 701 702 703 704
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
705
    listInstalled    :: Flag Bool,
706
    listSimpleOutput :: Flag Bool,
707 708
    listVerbosity    :: Flag Verbosity,
    listPackageDBs   :: [Maybe PackageDB]
709 710 711 712
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
713
    listInstalled    = Flag False,
714
    listSimpleOutput = Flag False,
715 716
    listVerbosity    = toFlag normal,
    listPackageDBs   = []
717 718 719 720 721
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
722
    commandSynopsis     = "List packages matching a search string.",
723
    commandDescription  = Nothing,
refold's avatar
refold committed
724
    commandUsage        = usageFlagsOrPackages "list",
725
    commandDefaultFlags = defaultListFlags,
726
    commandOptions      = \_ -> [
727
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
728

729
        , option [] ["installed"]
730 731 732 733
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

734 735 736 737 738
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

739 740 741 742 743
        , option "" ["package-db"]
          "Use a given package database. May be a specific file, 'global', 'user' or 'clear'."
          listPackageDBs (\v flags -> flags { listPackageDBs = v })
          (reqArg' "DB" readPackageDbList showPackageDbList)

744 745 746 747
        ]
  }

instance Monoid ListFlags where
748 749 750 751 752 753
  mempty = ListFlags {
    listInstalled    = mempty,
    listSimpleOutput = mempty,
    listVerbosity    = mempty,
    listPackageDBs   = mempty
    }
754
  mappend a b = ListFlags {
755
    listInstalled    = combine listInstalled,
756
    listSimpleOutput = combine listSimpleOutput,
757 758
    listVerbosity    = combine listVerbosity,
    listPackageDBs   = combine listPackageDBs
759 760 761
  }
    where combine field = field a `mappend` field b

762 763 764 765 766
-- ------------------------------------------------------------
-- * Info flags
-- ------------------------------------------------------------

data InfoFlags = InfoFlags {
767 768
    infoVerbosity  :: Flag Verbosity,
    infoPackageDBs :: [Maybe PackageDB]
769 770 771 772
  }

defaultInfoFlags :: InfoFlags
defaultInfoFlags = InfoFlags {
773 774
    infoVerbosity  = toFlag normal,
    infoPackageDBs = []
775 776 777 778 779 780 781
  }

infoCommand  :: CommandUI InfoFlags
infoCommand = CommandUI {
    commandName         = "info",
    commandSynopsis     = "Display detailed information about a particular package.",
    commandDescription  = Nothing,
refold's avatar
refold committed
782
    commandUsage        = usagePackages "info",
783 784 785
    commandDefaultFlags = defaultInfoFlags,
    commandOptions      = \_ -> [
        optionVerbosity infoVerbosity (\v flags -> flags { infoVerbosity = v })
786 787 788 789 790 791

        , option "" ["package-db"]
          "Use a given package database. May be a specific file, 'global', 'user' or 'clear'."
          infoPackageDBs (\v flags -> flags { infoPackageDBs = v })
          (reqArg' "DB" readPackageDbList showPackageDbList)

792 793 794 795
        ]
  }

instance Monoid InfoFlags where
796 797 798 799
  mempty = InfoFlags {
    infoVerbosity  = mempty,
    infoPackageDBs = mempty
    }
800
  mappend a b = InfoFlags {
801 802
    infoVerbosity  = combine infoVerbosity,
    infoPackageDBs = combine infoPackageDBs
803 804 805
  }
    where combine field = field a `mappend` field b

806 807 808 809
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

810 811
-- | Install takes the same flags as configure along with a few extras.
--
812
data InstallFlags = InstallFlags {
813 814 815
    installDocumentation    :: Flag Bool,
    installHaddockIndex     :: Flag PathTemplate,
    installDryRun           :: Flag Bool,
816 817 818
    installMaxBackjumps     :: Flag Int,
    installReorderGoals     :: Flag Bool,
    installIndependentGoals :: Flag Bool,
819
    installShadowPkgs       :: Flag Bool,
820 821
    installReinstall        :: Flag Bool,
    installAvoidReinstalls  :: Flag Bool,
822
    installOverrideReinstall :: Flag Bool,
823 824 825 826 827 828 829 830
    installUpgradeDeps      :: Flag Bool,
    installOnly             :: Flag Bool,
    installOnlyDeps         :: Flag Bool,
    installRootCmd          :: Flag String,
    installSummaryFile      :: [PathTemplate],
    installLogFile          :: Flag PathTemplate,
    installBuildReports     :: Flag ReportLevel,
    installSymlinkBinDir    :: Flag FilePath,
831
    installOneShot          :: Flag Bool,
832
    installNumJobs          :: Flag (Maybe Int)
833 834 835 836
  }

defaultInstallFlags :: InstallFlags
defaultInstallFlags = InstallFlags {
837 838 839
    installDocumentation   = Flag False,
    installHaddockIndex    = Flag docIndexFile,
    installDryRun          = Flag False,
840 841 842
    installMaxBackjumps    = Flag defaultMaxBackjumps,
    installReorderGoals    = Flag False,
    installIndependentGoals= Flag False,
843
    installShadowPkgs      = Flag False,
844 845
    installReinstall       = Flag False,
    installAvoidReinstalls = Flag False,
846
    installOverrideReinstall = Flag False,
847 848 849 850 851 852 853 854
    installUpgradeDeps     = Flag False,
    installOnly            = Flag False,
    installOnlyDeps        = Flag False,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = Flag NoReports,
    installSymlinkBinDir   = mempty,
855
    installOneShot         = Flag False,
856
    installNumJobs         = mempty
857
  }
858 859
  where
    docIndexFile = toPathTemplate ("$datadir" </> "doc" </> "index.html")
860

861 862 863
defaultMaxBackjumps :: Int
defaultMaxBackjumps = 200

864 865
defaultSolver :: PreSolver
defaultSolver = Choose
866 867

allSolvers :: String
868
allSolvers = intercalate ", " (map display ([minBound .. maxBound] :: [PreSolver]))
869

870
installCommand :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
871
installCommand = CommandUI {
872 873
  commandName         = "install",
  commandSynopsis     = "Installs a list of packages.",
refold's avatar
refold committed
874
  commandUsage        = usageFlagsOrPackages "install",
875 876 877 878 879
  commandDescription  = Just $ \pname ->
    let original = case commandDescription configureCommand of
          Just desc -> desc pname ++ "\n"
          Nothing   -> ""
     in original
880
     ++ "Examples:\n"
881 882 883 884 885 886 887 888
     ++ "  " ++ pname ++ " install                 "
     ++ "    Package in the current directory\n"
     ++ "  " ++ pname ++ " install foo             "
     ++ "    Package from the hackage server\n"
     ++ "  " ++ pname ++ " install foo-1.0         "
     ++ "    Specific version of a package\n"
     ++ "  " ++ pname ++ " install 'foo < 2'       "
     ++ "    Constrained package version\n",
889
  commandDefaultFlags = (mempty, mempty, mempty, mempty),
890
  commandOptions      = \showOrParseArgs ->
891 892
       liftOptions get1 set1
       (filter ((`notElem` ["constraint", "dependency"]) . optionName) $
893
                              configureOptions   showOrParseArgs)
894 895
    ++ liftOptions get2 set2 (configureExOptions showOrParseArgs)
    ++ liftOptions get3 set3 (installOptions     showOrParseArgs)
896
    ++ liftOptions get4 set4 (haddockOptions     showOrParseArgs)
897
  }
898
  where
899 900 901 902 903
    get1 (a,_,_,_) = a; set1 a (_,b,c,d) = (a,b,c,d)
    get2 (_,b,_,_) = b; set2 b (a,_,c,d) = (a,b,c,d)
    get3 (_,_,c,_) = c; set3 c (a,b,_,d) = (a,b,c,d)
    get4 (_,_,_,d) = d; set4 d (a,b,c,_) = (a,b,c,d)

904 905 906 907 908 909 910 911 912 913 914 915 916
haddockOptions :: ShowOrParseArgs -> [OptionField HaddockFlags]
haddockOptions showOrParseArgs
  = [ opt { optionName = "haddock-" ++ name,
            optionDescr = [ fmapOptFlags (\(_, lflags) -> ([], map ("haddock-" ++) lflags)) descr
                          | descr <- optionDescr opt] }
    | opt <- commandOptions Cabal.haddockCommand showOrParseArgs
    , let name = optionName opt
    , name `elem` ["hoogle", "html", "html-location",
                   "executables", "internal", "css",
                   "hyperlink-source", "hscolour-css",
                   "contents-location"]
    ]
  where
917 918 919 920 921
    fmapOptFlags :: (OptFlags -> OptFlags) -> OptDescr a -> OptDescr a
    fmapOptFlags modify (ReqArg d f p r w)    = ReqArg d (modify f) p r w
    fmapOptFlags modify (OptArg d f p r i w)  = OptArg d (modify f) p r i w
    fmapOptFlags modify (ChoiceOpt xs)        = ChoiceOpt [(d, modify f, i, w) | (d, f, i, w) <- xs]
    fmapOptFlags modify (BoolOpt d f1 f2 r w) = BoolOpt d (modify f1) (modify f2) r w
922 923 924 925

installOptions ::  ShowOrParseArgs -> [OptionField InstallFlags]
installOptions showOrParseArgs =
      [ option "" ["documentation"]
926 927 928 929
          "building of documentation"
          installDocumentation (\v flags -> flags { installDocumentation = v })
          (boolOpt [] [])

930 931
      , option [] ["doc-index-file"]
          "A central index of haddock API documentation (template cannot use $pkgid)"
932 933 934
          installHaddockIndex (\v flags -> flags { installHaddockIndex = v })
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
935

936
      , option [] ["dry-run"]
937 938 939
          "Do not install anything, only print what would be installed."
          installDryRun (\v flags -> flags { installDryRun = v })
          trueArg
940
      ] ++
941

942 943
      optionSolverFlags showOrParseArgs
                        installMaxBackjumps     (\v flags -> flags { installMaxBackjumps     = v })
944
                        installReorderGoals     (\v flags -> flags { installReorderGoals     = v })
945 946
                        installIndependentGoals (\v flags -> flags { installIndependentGoals = v })
                        installShadowPkgs       (\v flags -> flags { installShadowPkgs       = v }) ++
947

948
      [ option [] ["reinstall"]
949 950
          "Install even if it means installing the same version again."
          installReinstall (\v flags -> flags { installReinstall = v })
951
          (yesNoOpt showOrParseArgs)
952

953 954 955
      , option [] ["avoid-reinstalls"]
          "Do not select versions that would destructively overwrite installed packages."
          installAvoidReinstalls (\v flags -> flags { installAvoidReinstalls = v })
956
          (yesNoOpt showOrParseArgs)
957

958
      , option [] ["force-reinstalls"]
959
          "Reinstall packages even if they will most likely break other installed packages."
960
          installOverrideReinstall (\v flags -> flags { installOverrideReinstall = v })
961
          (yesNoOpt showOrParseArgs)