Setup.hs 71.7 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(..), defaultGlobalFlags, globalRepos
15
    , configureCommand, ConfigFlags(..), filterConfigureFlags
16 17
    , configureExCommand, ConfigExFlags(..), defaultConfigExFlags
                        , configureExOptions
18
    , buildCommand, BuildFlags(..), BuildExFlags(..), SkipAddSourceDepsCheck(..)
19
    , replCommand, 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
    , freezeCommand, FreezeFlags(..)
27
    , getCommand, unpackCommand, GetFlags(..)
28
    , checkCommand
29
    , formatCommand
30
    , uploadCommand, UploadFlags(..)
31
    , reportCommand, ReportFlags(..)
refold's avatar
refold committed
32
    , runCommand
33
    , initCommand, IT.InitFlags(..)
34
    , sdistCommand, SDistFlags(..), SDistExFlags(..), ArchiveFormat(..)
35
    , win32SelfUpgradeCommand, Win32SelfUpgradeFlags(..)
refold's avatar
refold committed
36
    , sandboxCommand, defaultSandboxLocation, SandboxFlags(..)
37
    , execCommand, ExecFlags(..)
38
    , userConfigCommand, UserConfigFlags(..)
Duncan Coutts's avatar
Duncan Coutts committed
39 40

    , parsePackageArgs
41 42 43
    --TODO: stop exporting these:
    , showRepo
    , parseRepo
44 45
    ) where

46
import Distribution.Client.Types
47
         ( Username(..), Password(..), Repo(..), RemoteRepo(..), LocalRepo(..) )
48 49
import Distribution.Client.BuildReports.Types
         ( ReportLevel(..) )
50
import Distribution.Client.Dependency.Types
51
         ( AllowNewer(..), PreSolver(..) )
52 53
import qualified Distribution.Client.Init.Types as IT
         ( InitFlags(..), PackageType(..) )
54 55
import Distribution.Client.Targets
         ( UserConstraint, readUserConstraint )
56 57
import Distribution.Utils.NubList
         ( NubList, toNubList, fromNubList)
58

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

92 93
import Data.Char
         ( isSpace, isAlphaNum )
94 95
import Data.List
         ( intercalate )
96
import Data.Maybe
97
         ( listToMaybe, maybeToList, fromMaybe )
98 99 100 101 102 103 104 105
import Data.Monoid
         ( Monoid(..) )
import Control.Monad
         ( liftM )
import System.FilePath
         ( (</>) )
import Network.URI
         ( parseAbsoluteURI, uriToString )
106

107 108 109 110 111 112
-- ------------------------------------------------------------
-- * Global flags
-- ------------------------------------------------------------

-- | Flags that apply at the top level, not to any sub-command.
data GlobalFlags = GlobalFlags {
113 114 115 116
    globalVersion           :: Flag Bool,
    globalNumericVersion    :: Flag Bool,
    globalConfigFile        :: Flag FilePath,
    globalSandboxConfigFile :: Flag FilePath,
117
    globalRemoteRepos       :: NubList RemoteRepo,     -- ^ Available Hackage servers.
118
    globalCacheDir          :: Flag FilePath,
119
    globalLocalRepos        :: NubList FilePath,
120
    globalLogsDir           :: Flag FilePath,
121
    globalWorldFile         :: Flag FilePath,
122 123
    globalRequireSandbox    :: Flag Bool,
    globalIgnoreSandbox     :: Flag Bool
124
  }
Duncan Coutts's avatar
Duncan Coutts committed
125

126 127
defaultGlobalFlags :: GlobalFlags
defaultGlobalFlags  = GlobalFlags {
128 129 130 131
    globalVersion           = Flag False,
    globalNumericVersion    = Flag False,
    globalConfigFile        = mempty,
    globalSandboxConfigFile = mempty,
132
    globalRemoteRepos       = mempty,
133 134 135
    globalCacheDir          = mempty,
    globalLocalRepos        = mempty,
    globalLogsDir           = mempty,
136
    globalWorldFile         = mempty,
137 138
    globalRequireSandbox    = Flag False,
    globalIgnoreSandbox     = Flag False
139 140 141 142 143 144
  }

globalCommand :: CommandUI GlobalFlags
globalCommand = CommandUI {
    commandName         = "",
    commandSynopsis     = "",
145 146 147 148
    commandUsage        = \_ ->
         "This program is the command line interface "
           ++ "to the Haskell Cabal infrastructure.\n"
      ++ "See http://www.haskell.org/cabal/ for more information.\n",
149
    commandDescription  = Just $ \pname ->
150 151 152 153 154 155
         "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",
156
    commandDefaultFlags = mempty,
157
    commandOptions      = \showOrParseArgs ->
158
      (case showOrParseArgs of ShowArgs -> take 6; ParseArgs -> id)
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
      [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")

174 175 176 177 178 179
      ,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")

180
      ,option [] ["require-sandbox"]
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
181
         "requiring the presence of a sandbox for sandbox-aware commands"
182 183 184
         globalRequireSandbox (\v flags -> flags { globalRequireSandbox = v })
         (boolOpt' ([], ["require-sandbox"]) ([], ["no-require-sandbox"]))

185 186 187 188 189
      ,option [] ["ignore-sandbox"]
         "Ignore any existing sandbox"
         globalIgnoreSandbox (\v flags -> flags { globalIgnoreSandbox = v })
         trueArg

190 191 192
      ,option [] ["remote-repo"]
         "The name and url for a remote repository"
         globalRemoteRepos (\v flags -> flags { globalRemoteRepos = v })
193
         (reqArg' "NAME:URL" (toNubList . maybeToList . readRepo) (map showRepo . fromNubList))
194 195 196 197 198 199 200 201 202

      ,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 })
203
         (reqArg' "DIR" (\x -> toNubList [x]) fromNubList)
204

205 206 207 208 209
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

210 211 212 213
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
214 215 216 217 218
      ]
  }

instance Monoid GlobalFlags where
  mempty = GlobalFlags {
219 220 221 222 223 224 225 226
    globalVersion           = mempty,
    globalNumericVersion    = mempty,
    globalConfigFile        = mempty,
    globalSandboxConfigFile = mempty,
    globalRemoteRepos       = mempty,
    globalCacheDir          = mempty,
    globalLocalRepos        = mempty,
    globalLogsDir           = mempty,
227
    globalWorldFile         = mempty,
228 229
    globalRequireSandbox    = mempty,
    globalIgnoreSandbox     = mempty
230 231
  }
  mappend a b = GlobalFlags {
232 233 234 235 236 237 238 239
    globalVersion           = combine globalVersion,
    globalNumericVersion    = combine globalNumericVersion,
    globalConfigFile        = combine globalConfigFile,
    globalSandboxConfigFile = combine globalConfigFile,
    globalRemoteRepos       = combine globalRemoteRepos,
    globalCacheDir          = combine globalCacheDir,
    globalLocalRepos        = combine globalLocalRepos,
    globalLogsDir           = combine globalLogsDir,
240
    globalWorldFile         = combine globalWorldFile,
241 242
    globalRequireSandbox    = combine globalRequireSandbox,
    globalIgnoreSandbox     = combine globalIgnoreSandbox
Duncan Coutts's avatar
Duncan Coutts committed
243
  }
244 245 246 247 248 249 250
    where combine field = field a `mappend` field b

globalRepos :: GlobalFlags -> [Repo]
globalRepos globalFlags = remoteRepos ++ localRepos
  where
    remoteRepos =
      [ Repo (Left remote) cacheDir
251
      | remote <- fromNubList $ globalRemoteRepos globalFlags
252 253 254 255
      , let cacheDir = fromFlag (globalCacheDir globalFlags)
                   </> remoteRepoName remote ]
    localRepos =
      [ Repo (Right LocalRepo) local
256
      | local <- fromNubList $ globalLocalRepos globalFlags ]
257 258 259 260

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

262
configureCommand :: CommandUI ConfigFlags
263
configureCommand = (Cabal.configureCommand defaultProgramConfiguration) {
264
    commandDefaultFlags = mempty
Duncan Coutts's avatar
Duncan Coutts committed
265 266
  }

267 268 269
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

270
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
271
filterConfigureFlags flags cabalLibVersion
272
  | cabalLibVersion >= Version [1,19,2] [] = flags_latest
273 274 275
  | 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
276
  | cabalLibVersion <  Version [1,18,0] [] = flags_1_18_0
277
  | cabalLibVersion <  Version [1,19,1] [] = flags_1_19_0
278
  | cabalLibVersion <  Version [1,19,2] [] = flags_1_19_1
279
  | cabalLibVersion <  Version [1,21,1] [] = flags_1_21_1
280
  | otherwise = flags_latest
281
  where
282
    -- Cabal >= 1.19.1 uses '--dependency' and does not need '--constraint'.
283 284
    flags_latest = flags        { configConstraints = [] }

285 286
    -- Cabal < 1.21.1 doesn't know about 'disable-relocatable'
    flags_1_21_1 = flags_latest { configRelocatable = NoFlag }
287
    -- Cabal < 1.19.2 doesn't know about '--exact-configuration'.
288
    flags_1_19_1 = flags_1_21_1 { configExactConfiguration = NoFlag }
289 290 291
    -- Cabal < 1.19.1 uses '--constraint' instead of '--dependency'.
    flags_1_19_0 = flags_1_19_1 { configDependencies = []
                                , configConstraints  = configConstraints flags }
292
    -- Cabal < 1.18.0 doesn't know about --extra-prog-path and --sysconfdir.
293
    flags_1_18_0 = flags_1_19_0 { configProgramPathExtra = toNubList []
294 295
                                , configInstallDirs = configInstallDirs_1_18_0}
    configInstallDirs_1_18_0 = (configInstallDirs flags) { sysconfdir = NoFlag }
296
    -- Cabal < 1.14.0 doesn't know about '--disable-benchmarks'.
297
    flags_1_14_0 = flags_1_18_0 { configBenchmarks  = NoFlag }
298
    -- Cabal < 1.10.0 doesn't know about '--disable-tests'.
299
    flags_1_10_0 = flags_1_14_0 { configTests       = NoFlag }
300
    -- Cabal < 1.3.10 does not grok the '--constraints' flag.
301
    flags_1_3_10 = flags_1_10_0 { configConstraints = [] }
302

303 304 305 306 307 308 309 310
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
311
    configExConstraints:: [UserConstraint],
312
    configPreferences  :: [Dependency],
313 314
    configSolver       :: Flag PreSolver,
    configAllowNewer   :: Flag AllowNewer
315 316 317
  }

defaultConfigExFlags :: ConfigExFlags
318 319
defaultConfigExFlags = mempty { configSolver     = Flag defaultSolver
                              , configAllowNewer = Flag AllowNewerNone }
320 321 322 323 324

configureExCommand :: CommandUI (ConfigFlags, ConfigExFlags)
configureExCommand = configureCommand {
    commandDefaultFlags = (mempty, defaultConfigExFlags),
    commandOptions      = \showOrParseArgs ->
325
         liftOptions fst setFst
326
         (filter ((`notElem` ["constraint", "dependency", "exact-configuration"])
327
                  . optionName) $ configureOptions  showOrParseArgs)
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
      ++ 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))
343 344 345 346 347 348
  , 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))
349 350 351 352

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
353 354 355 356
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
357 358

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

  , option [] ["allow-newer"]
cheecheeo's avatar
cheecheeo committed
361
    ("Ignore upper bounds in all dependencies or " ++ allowNewerArgument)
362
    configAllowNewer (\v flags -> flags { configAllowNewer = v})
cheecheeo's avatar
cheecheeo committed
363
    (optArg allowNewerArgument
364 365 366
     (fmap Flag allowNewerParser) (Flag AllowNewerAll)
     allowNewerPrinter)

367
  ]
cheecheeo's avatar
cheecheeo committed
368
  where allowNewerArgument = "DEPS"
369 370 371 372

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
373
    configExConstraints= mempty,
374
    configPreferences  = mempty,
375 376
    configSolver       = mempty,
    configAllowNewer   = mempty
377 378 379
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
380
    configExConstraints= combine configExConstraints,
381
    configPreferences  = combine configPreferences,
382 383
    configSolver       = combine configSolver,
    configAllowNewer   = combine configAllowNewer
384 385 386
  }
    where combine field = field a `mappend` field b

ttuegel's avatar
ttuegel committed
387 388 389 390
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

391 392 393 394 395 396 397 398 399 400
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
}

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
401
  option [] ["only"]
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
  "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

-- ------------------------------------------------------------
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
-- * 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)

    parent = Cabal.replCommand defaultProgramConfiguration

451 452 453 454
-- ------------------------------------------------------------
-- * Test command
-- ------------------------------------------------------------

455
testCommand :: CommandUI (TestFlags, BuildFlags, BuildExFlags)
456
testCommand = parent {
457 458
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
459
  commandOptions      =
460
    \showOrParseArgs -> liftOptions get1 set1
461 462
                        (commandOptions parent showOrParseArgs)
                        ++
463 464 465 466
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
467 468
  }
  where
469 470 471
    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)
472

473 474
    parent   = Cabal.testCommand
    progConf = defaultProgramConfiguration
475 476 477 478 479

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

480
benchmarkCommand :: CommandUI (BenchmarkFlags, BuildFlags, BuildExFlags)
481
benchmarkCommand = parent {
482 483
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
484
  commandOptions      =
485
    \showOrParseArgs -> liftOptions get1 set1
486 487
                        (commandOptions parent showOrParseArgs)
                        ++
488 489 490 491
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
ttuegel's avatar
ttuegel committed
492
  }
493
  where
494 495 496
    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)
497

498 499
    parent   = Cabal.benchmarkCommand
    progConf = defaultProgramConfiguration
ttuegel's avatar
ttuegel committed
500

501
-- ------------------------------------------------------------
502
-- * Fetch command
503
-- ------------------------------------------------------------
504

505 506 507 508
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
509
      fetchSolver           :: Flag PreSolver,
510 511 512
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
513
      fetchShadowPkgs       :: Flag Bool,
Andres Löh's avatar
Andres Löh committed
514
      fetchStrongFlags      :: Flag Bool,
515 516 517 518 519 520 521 522
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
523 524
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
525
    fetchReorderGoals     = Flag False,
526
    fetchIndependentGoals = Flag False,
527
    fetchShadowPkgs       = Flag False,
Andres Löh's avatar
Andres Löh committed
528
    fetchStrongFlags      = Flag False,
529 530 531 532
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
533 534
fetchCommand = CommandUI {
    commandName         = "fetch",
535
    commandSynopsis     = "Downloads packages for later installation.",
Duncan Coutts's avatar
Duncan Coutts committed
536
    commandDescription  = Nothing,
refold's avatar
refold committed
537
    commandUsage        = usagePackages "fetch",
538
    commandDefaultFlags = defaultFetchFlags,
539
    commandOptions      = \ showOrParseArgs -> [
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
         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
561 562 563 564

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
565 566
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
567 568
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
569
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
Andres Löh's avatar
Andres Löh committed
570
                         fetchStrongFlags      (\v flags -> flags { fetchStrongFlags      = v })
571

Duncan Coutts's avatar
Duncan Coutts committed
572 573
  }

574 575 576 577 578 579
-- ------------------------------------------------------------
-- * Freeze command
-- ------------------------------------------------------------

data FreezeFlags = FreezeFlags {
      freezeDryRun           :: Flag Bool,
580 581
      freezeTests            :: Flag Bool,
      freezeBenchmarks       :: Flag Bool,
582 583 584 585 586
      freezeSolver           :: Flag PreSolver,
      freezeMaxBackjumps     :: Flag Int,
      freezeReorderGoals     :: Flag Bool,
      freezeIndependentGoals :: Flag Bool,
      freezeShadowPkgs       :: Flag Bool,
Andres Löh's avatar
Andres Löh committed
587
      freezeStrongFlags      :: Flag Bool,
588 589 590 591 592 593
      freezeVerbosity        :: Flag Verbosity
    }

defaultFreezeFlags :: FreezeFlags
defaultFreezeFlags = FreezeFlags {
    freezeDryRun           = toFlag False,
594 595
    freezeTests            = toFlag False,
    freezeBenchmarks       = toFlag False,
596 597
    freezeSolver           = Flag defaultSolver,
    freezeMaxBackjumps     = Flag defaultMaxBackjumps,
598
    freezeReorderGoals     = Flag False,
599 600
    freezeIndependentGoals = Flag False,
    freezeShadowPkgs       = Flag False,
Andres Löh's avatar
Andres Löh committed
601
    freezeStrongFlags      = Flag False,
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
    freezeVerbosity        = toFlag normal
   }

freezeCommand :: CommandUI FreezeFlags
freezeCommand = CommandUI {
    commandName         = "freeze",
    commandSynopsis     = "Freeze dependencies.",
    commandDescription  = Nothing,
    commandUsage        = usagePackages "freeze",
    commandDefaultFlags = defaultFreezeFlags,
    commandOptions      = \ showOrParseArgs -> [
         optionVerbosity freezeVerbosity (\v flags -> flags { freezeVerbosity = v })

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

620 621 622 623 624 625 626 627 628 629
       , option [] ["tests"]
           "freezing of the dependencies of any tests suites in the package description file."
           freezeTests (\v flags -> flags { freezeTests = v })
           (boolOpt [] [])

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

630 631 632 633 634 635 636 637
       ] ++

       optionSolver      freezeSolver           (\v flags -> flags { freezeSolver           = v }) :
       optionSolverFlags showOrParseArgs
                         freezeMaxBackjumps     (\v flags -> flags { freezeMaxBackjumps     = v })
                         freezeReorderGoals     (\v flags -> flags { freezeReorderGoals     = v })
                         freezeIndependentGoals (\v flags -> flags { freezeIndependentGoals = v })
                         freezeShadowPkgs       (\v flags -> flags { freezeShadowPkgs       = v })
Andres Löh's avatar
Andres Löh committed
638
                         freezeStrongFlags      (\v flags -> flags { freezeStrongFlags      = v })
639 640 641

  }

642 643 644 645
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

646
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
647 648
updateCommand = CommandUI {
    commandName         = "update",
649
    commandSynopsis     = "Updates list of known packages.",
Duncan Coutts's avatar
Duncan Coutts committed
650
    commandDescription  = Nothing,
refold's avatar
refold committed
651
    commandUsage        = usageFlags "update",
652
    commandDefaultFlags = toFlag normal,
653
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
654 655
  }

656
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
657
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
658
    commandName         = "upgrade",
659
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
660
    commandDescription  = Nothing,
refold's avatar
refold committed
661
    commandUsage        = usageFlagsOrPackages "upgrade",
662
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
663
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
664 665
  }

Duncan Coutts's avatar
Duncan Coutts committed
666 667 668 669 670 671 672 673 674 675 676
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

677 678 679
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
680
    commandSynopsis     = "Check the package for common mistakes.",
681 682
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
683
    commandDefaultFlags = toFlag normal,
684
    commandOptions      = \_ -> []
685 686
  }

687 688 689 690 691 692 693 694 695 696
formatCommand  :: CommandUI (Flag Verbosity)
formatCommand = CommandUI {
    commandName         = "format",
    commandSynopsis     = "Reformat the .cabal file using the standard style.",
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " format [FILE]\n",
    commandDefaultFlags = toFlag normal,
    commandOptions      = \_ -> []
  }

697
runCommand :: CommandUI (BuildFlags, BuildExFlags)
refold's avatar
refold committed
698 699 700 701 702
runCommand = CommandUI {
    commandName         = "run",
    commandSynopsis     = "Runs the compiled executable.",
    commandDescription  = Nothing,
    commandUsage        =
703 704 705
      \pname -> "Usage: " ++ pname
                ++ " run [FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]\n\n"
                ++ "Flags for run:",
refold's avatar
refold committed
706
    commandDefaultFlags = mempty,
707 708
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
709
                          (commandOptions parent showOrParseArgs)
710 711 712
                          ++
                          liftOptions snd setSnd
                          (buildExOptions showOrParseArgs)
refold's avatar
refold committed
713 714
  }
  where
715 716 717
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

718
    parent = Cabal.buildCommand defaultProgramConfiguration
refold's avatar
refold committed
719

720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
-- ------------------------------------------------------------
-- * 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
738 739 740
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
    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))
      ]
761 762
  }

763 764 765 766 767 768 769 770 771 772 773 774 775
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

776
-- ------------------------------------------------------------
777
-- * Get flags
778 779
-- ------------------------------------------------------------

780 781 782 783 784 785
data GetFlags = GetFlags {
    getDestDir          :: Flag FilePath,
    getPristine         :: Flag Bool,
    getSourceRepository :: Flag (Maybe RepoKind),
    getVerbosity        :: Flag Verbosity
  }
786

787 788 789 790 791 792
defaultGetFlags :: GetFlags
defaultGetFlags = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = toFlag normal
793 794
   }

795 796 797 798
getCommand :: CommandUI GetFlags
getCommand = CommandUI {
    commandName         = "get",
    commandSynopsis     = "Gets a package's source code.",
799 800 801 802 803
    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",
804
    commandUsage        = usagePackages "get",
805
    commandDefaultFlags = defaultGetFlags,
806
    commandOptions      = \_ -> [
807
        optionVerbosity getVerbosity (\v flags -> flags { getVerbosity = v })
808 809

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

814
       ,option "s" ["source-repository"]
815
         "Copy the package's source repository (ie git clone, darcs get, etc as appropriate)."
816 817 818 819 820 821
         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))

822 823 824
       , option [] ["pristine"]
           ("Unpack the original pristine tarball, rather than updating the "
           ++ ".cabal file with the latest revision from the package archive.")
825
           getPristine (\v flags -> flags { getPristine = v })
826
           trueArg
827 828 829
       ]
  }

830 831 832 833 834 835 836
-- 'cabal unpack' is a deprecated alias for 'cabal get'.
unpackCommand :: CommandUI GetFlags
unpackCommand = getCommand {
  commandName  = "unpack",
  commandUsage = usagePackages "unpack"
  }

837
instance Monoid GetFlags where
838 839 840 841 842 843
  mempty = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = mempty
    }
844 845 846 847 848
  mappend a b = GetFlags {
    getDestDir          = combine getDestDir,
    getPristine         = combine getPristine,
    getSourceRepository = combine getSourceRepository,
    getVerbosity        = combine getVerbosity
849 850 851
  }
    where combine field = field a `mappend` field b

852 853 854 855 856
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
857
    listInstalled    :: Flag Bool,
858
    listSimpleOutput :: Flag Bool,
859 860
    listVerbosity    :: Flag Verbosity,
    listPackageDBs   :: [Maybe PackageDB]
861 862 863 864
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
865
    listInstalled    = Flag False,
866
    listSimpleOutput = Flag False,
867 868
    listVerbosity    = toFlag normal,
    listPackageDBs   = []
869 870 871 872 873
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
874
    commandSynopsis     = "List packages matching a search string.",
875
    commandDescription  = Nothing,
refold's avatar
refold committed
876
    commandUsage        = usageFlagsOrPackages "list",
877
    commandDefaultFlags = defaultListFlags,
878
    commandOptions      = \_ -> [
879
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
880

881
        , option [] ["installed"]
882 883 884 885
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

886 887 888 889 890
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

891 892 893 894 895
        , 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)

896 897 898 899
        ]
  }

instance Monoid ListFlags where
900 901 902 903 904 905
  mempty = ListFlags {
    listInstalled    = mempty,
    listSimpleOutput = mempty,
    listVerbosity    = mempty,
    listPackageDBs   = mempty
    }
906
  mappend a b = ListFlags {
907
    listInstalled    = combine listInstalled,
908
    listSimpleOutput = combine listSimpleOutput,
909 910
    listVerbosity    = combine listVerbosity,
    listPackageDBs   = combine listPackageDBs
911 912 913
  }
    where combine field = field a `mappend` field b

914 915 916 917 918
-- ------------------------------------------------------------
-- * Info flags
-- ------------------------------------------------------------

data InfoFlags = InfoFlags {
919 920
    infoVerbosity  :: Flag Verbosity,
    infoPackageDBs :: [Maybe PackageDB]
921 922 923 924
  }

defaultInfoFlags :: InfoFlags
defaultInfoFlags = InfoFlags {
925 926
    infoVerbosity  = toFlag normal,
    infoPackageDBs = []
927 928 929 930 931 932 933
  }

infoCommand  :: CommandUI InfoFlags
infoCommand = CommandUI {
    commandName         = "info",
    commandSynopsis     = "Display detailed information about a particular package.",
    commandDescription  = Nothing,
refold's avatar
refold committed
934
    commandUsage        = usagePackages "info",
935 936 937
    commandDefaultFlags = defaultInfoFlags,
    commandOptions      = \_ -> [
        optionVerbosity infoVerbosity (\v flags -> flags { infoVerbosity = v })
938 939 940 941 942 943

        , 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)

944 945 946 947
        ]
  }

instance Monoid InfoFlags where
<