Setup.hs 69.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(..)
Duncan Coutts's avatar
Duncan Coutts committed
38 39

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

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

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

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

104 105 106 107 108 109
-- ------------------------------------------------------------
-- * Global flags
-- ------------------------------------------------------------

-- | Flags that apply at the top level, not to any sub-command.
data GlobalFlags = GlobalFlags {
110 111 112 113 114 115 116 117
    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,
118
    globalWorldFile         :: Flag FilePath,
119 120
    globalRequireSandbox    :: Flag Bool,
    globalIgnoreSandbox     :: Flag Bool
121
  }
Duncan Coutts's avatar
Duncan Coutts committed
122

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

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

171 172 173 174 175 176
      ,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")

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

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

187 188 189 190 191 192 193 194 195 196 197 198 199 200
      ,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)
201

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

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

instance Monoid GlobalFlags where
  mempty = GlobalFlags {
216 217 218 219 220 221 222 223
    globalVersion           = mempty,
    globalNumericVersion    = mempty,
    globalConfigFile        = mempty,
    globalSandboxConfigFile = mempty,
    globalRemoteRepos       = mempty,
    globalCacheDir          = mempty,
    globalLocalRepos        = mempty,
    globalLogsDir           = mempty,
224
    globalWorldFile         = mempty,
225 226
    globalRequireSandbox    = mempty,
    globalIgnoreSandbox     = mempty
227 228
  }
  mappend a b = GlobalFlags {
229 230 231 232 233 234 235 236
    globalVersion           = combine globalVersion,
    globalNumericVersion    = combine globalNumericVersion,
    globalConfigFile        = combine globalConfigFile,
    globalSandboxConfigFile = combine globalConfigFile,
    globalRemoteRepos       = combine globalRemoteRepos,
    globalCacheDir          = combine globalCacheDir,
    globalLocalRepos        = combine globalLocalRepos,
    globalLogsDir           = combine globalLogsDir,
237
    globalWorldFile         = combine globalWorldFile,
238 239
    globalRequireSandbox    = combine globalRequireSandbox,
    globalIgnoreSandbox     = combine globalIgnoreSandbox
Duncan Coutts's avatar
Duncan Coutts committed
240
  }
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
    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
258

259
configureCommand :: CommandUI ConfigFlags
260
configureCommand = (Cabal.configureCommand defaultProgramConfiguration) {
261
    commandDefaultFlags = mempty
Duncan Coutts's avatar
Duncan Coutts committed
262 263
  }

264 265 266
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

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

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

297 298 299 300 301 302 303 304
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
305
    configExConstraints:: [UserConstraint],
306
    configPreferences  :: [Dependency],
307 308
    configSolver       :: Flag PreSolver,
    configAllowNewer   :: Flag AllowNewer
309 310 311
  }

defaultConfigExFlags :: ConfigExFlags
312 313
defaultConfigExFlags = mempty { configSolver     = Flag defaultSolver
                              , configAllowNewer = Flag AllowNewerNone }
314 315 316 317 318

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

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
347 348 349 350
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
351 352

  , optionSolver configSolver (\v flags -> flags { configSolver = v })
353 354 355 356 357 358 359 360

  , option [] ["allow-newer"]
    "Ignore upper bounds in dependencies on some or all packages."
    configAllowNewer (\v flags -> flags { configAllowNewer = v})
    (optArg "PKGS"
     (fmap Flag allowNewerParser) (Flag AllowNewerAll)
     allowNewerPrinter)

361 362 363 364 365
  ]

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
366
    configExConstraints= mempty,
367
    configPreferences  = mempty,
368 369
    configSolver       = mempty,
    configAllowNewer   = mempty
370 371 372
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
373
    configExConstraints= combine configExConstraints,
374
    configPreferences  = combine configPreferences,
375 376
    configSolver       = combine configSolver,
    configAllowNewer   = combine configAllowNewer
377 378 379
  }
    where combine field = field a `mappend` field b

ttuegel's avatar
ttuegel committed
380 381 382 383
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

384 385 386 387 388 389 390 391 392 393
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
}

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
394
  option [] ["only"]
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
  "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

-- ------------------------------------------------------------
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
-- * 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

444 445 446 447
-- ------------------------------------------------------------
-- * Test command
-- ------------------------------------------------------------

448
testCommand :: CommandUI (TestFlags, BuildFlags, BuildExFlags)
449
testCommand = parent {
450 451
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
452
  commandOptions      =
453
    \showOrParseArgs -> liftOptions get1 set1
454 455
                        (commandOptions parent showOrParseArgs)
                        ++
456 457 458 459
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
460 461
  }
  where
462 463 464
    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)
465

466 467
    parent   = Cabal.testCommand
    progConf = defaultProgramConfiguration
468 469 470 471 472

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

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

491 492
    parent   = Cabal.benchmarkCommand
    progConf = defaultProgramConfiguration
ttuegel's avatar
ttuegel committed
493

494
-- ------------------------------------------------------------
495
-- * Fetch command
496
-- ------------------------------------------------------------
497

498 499 500 501
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
502
      fetchSolver           :: Flag PreSolver,
503 504 505
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
506
      fetchShadowPkgs       :: Flag Bool,
Andres Löh's avatar
Andres Löh committed
507
      fetchStrongFlags      :: Flag Bool,
508 509 510 511 512 513 514 515
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
516 517
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
518
    fetchReorderGoals     = Flag False,
519
    fetchIndependentGoals = Flag False,
520
    fetchShadowPkgs       = Flag False,
Andres Löh's avatar
Andres Löh committed
521
    fetchStrongFlags      = Flag False,
522 523 524 525
    fetchVerbosity = toFlag normal
   }

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

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
558 559
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
560 561
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
562
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
Andres Löh's avatar
Andres Löh committed
563
                         fetchStrongFlags      (\v flags -> flags { fetchStrongFlags      = v })
564

Duncan Coutts's avatar
Duncan Coutts committed
565 566
  }

567 568 569 570 571 572
-- ------------------------------------------------------------
-- * Freeze command
-- ------------------------------------------------------------

data FreezeFlags = FreezeFlags {
      freezeDryRun           :: Flag Bool,
573 574
      freezeTests            :: Flag Bool,
      freezeBenchmarks       :: Flag Bool,
575 576 577 578 579
      freezeSolver           :: Flag PreSolver,
      freezeMaxBackjumps     :: Flag Int,
      freezeReorderGoals     :: Flag Bool,
      freezeIndependentGoals :: Flag Bool,
      freezeShadowPkgs       :: Flag Bool,
Andres Löh's avatar
Andres Löh committed
580
      freezeStrongFlags      :: Flag Bool,
581 582 583 584 585 586
      freezeVerbosity        :: Flag Verbosity
    }

defaultFreezeFlags :: FreezeFlags
defaultFreezeFlags = FreezeFlags {
    freezeDryRun           = toFlag False,
587 588
    freezeTests            = toFlag False,
    freezeBenchmarks       = toFlag False,
589 590
    freezeSolver           = Flag defaultSolver,
    freezeMaxBackjumps     = Flag defaultMaxBackjumps,
591
    freezeReorderGoals     = Flag False,
592 593
    freezeIndependentGoals = Flag False,
    freezeShadowPkgs       = Flag False,
Andres Löh's avatar
Andres Löh committed
594
    freezeStrongFlags      = Flag False,
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
    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

613 614 615 616 617 618 619 620 621 622
       , 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 [] [])

623 624 625 626 627 628 629 630
       ] ++

       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
631
                         freezeStrongFlags      (\v flags -> flags { freezeStrongFlags      = v })
632 633 634

  }

635 636 637 638
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

639
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
640 641
updateCommand = CommandUI {
    commandName         = "update",
642
    commandSynopsis     = "Updates list of known packages.",
Duncan Coutts's avatar
Duncan Coutts committed
643
    commandDescription  = Nothing,
refold's avatar
refold committed
644
    commandUsage        = usageFlags "update",
645
    commandDefaultFlags = toFlag normal,
646
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
647 648
  }

649
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
650
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
651
    commandName         = "upgrade",
652
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
653
    commandDescription  = Nothing,
refold's avatar
refold committed
654
    commandUsage        = usageFlagsOrPackages "upgrade",
655
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
656
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
657 658
  }

Duncan Coutts's avatar
Duncan Coutts committed
659 660 661 662 663 664 665 666 667 668 669
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

670 671 672
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
673
    commandSynopsis     = "Check the package for common mistakes.",
674 675
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
676
    commandDefaultFlags = toFlag normal,
677
    commandOptions      = \_ -> []
678 679
  }

680 681 682 683 684 685 686 687 688 689
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      = \_ -> []
  }

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

711
    parent = Cabal.buildCommand defaultProgramConfiguration
refold's avatar
refold committed
712

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

756 757 758 759 760 761 762 763 764 765 766 767 768
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

769
-- ------------------------------------------------------------
770
-- * Get flags
771 772
-- ------------------------------------------------------------

773 774 775 776 777 778
data GetFlags = GetFlags {
    getDestDir          :: Flag FilePath,
    getPristine         :: Flag Bool,
    getSourceRepository :: Flag (Maybe RepoKind),
    getVerbosity        :: Flag Verbosity
  }
779

780 781 782 783 784 785
defaultGetFlags :: GetFlags
defaultGetFlags = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = toFlag normal
786 787
   }

788 789 790 791
getCommand :: CommandUI GetFlags
getCommand = CommandUI {
    commandName         = "get",
    commandSynopsis     = "Gets a package's source code.",
792 793 794 795 796
    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",
797
    commandUsage        = usagePackages "get",
798
    commandDefaultFlags = defaultGetFlags,
799
    commandOptions      = \_ -> [
800
        optionVerbosity getVerbosity (\v flags -> flags { getVerbosity = v })
801 802

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

807
       ,option "s" ["source-repository"]
808
         "Copy the package's source repository (ie git clone, darcs get, etc as appropriate)."
809 810 811 812 813 814
         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))

815 816 817
       , option [] ["pristine"]
           ("Unpack the original pristine tarball, rather than updating the "
           ++ ".cabal file with the latest revision from the package archive.")
818
           getPristine (\v flags -> flags { getPristine = v })
819
           trueArg
820 821 822
       ]
  }

823 824 825 826 827 828 829
-- 'cabal unpack' is a deprecated alias for 'cabal get'.
unpackCommand :: CommandUI GetFlags
unpackCommand = getCommand {
  commandName  = "unpack",
  commandUsage = usagePackages "unpack"
  }

830
instance Monoid GetFlags where
831 832 833 834 835 836
  mempty = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = mempty
    }
837 838 839 840 841
  mappend a b = GetFlags {
    getDestDir          = combine getDestDir,
    getPristine         = combine getPristine,
    getSourceRepository = combine getSourceRepository,
    getVerbosity        = combine getVerbosity
842 843 844
  }
    where combine field = field a `mappend` field b

845 846 847 848 849
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
850
    listInstalled    :: Flag Bool,
851
    listSimpleOutput :: Flag Bool,
852 853
    listVerbosity    :: Flag Verbosity,
    listPackageDBs   :: [Maybe PackageDB]
854 855 856 857
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
858
    listInstalled    = Flag False,
859
    listSimpleOutput = Flag False,
860 861
    listVerbosity    = toFlag normal,
    listPackageDBs   = []
862 863 864 865 866
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
867
    commandSynopsis     = "List packages matching a search string.",
868
    commandDescription  = Nothing,
refold's avatar
refold committed
869
    commandUsage        = usageFlagsOrPackages "list",
870
    commandDefaultFlags = defaultListFlags,
871
    commandOptions      = \_ -> [
872
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
873

874
        , option [] ["installed"]
875 876 877 878
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

879 880 881 882 883
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

884 885 886 887 888
        , 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)

889 890 891 892
        ]
  }

instance Monoid ListFlags where
893 894 895 896 897 898
  mempty = ListFlags {
    listInstalled    = mempty,
    listSimpleOutput = mempty,
    listVerbosity    = mempty,
    listPackageDBs   = mempty
    }
899
  mappend a b = ListFlags {
900
    listInstalled    = combine listInstalled,
901
    listSimpleOutput = combine listSimpleOutput,
902 903
    listVerbosity    = combine listVerbosity,
    listPackageDBs   = combine listPackageDBs
904 905 906
  }
    where combine field = field a `mappend` field b

907 908 909 910 911
-- ------------------------------------------------------------
-- * Info flags
-- ------------------------------------------------------------

data InfoFlags = InfoFlags {
912 913
    infoVerbosity  :: Flag Verbosity,
    infoPackageDBs :: [Maybe PackageDB]
914 915 916 917
  }

defaultInfoFlags :: InfoFlags
defaultInfoFlags = InfoFlags {
918 919
    infoVerbosity  = toFlag normal,
    infoPackageDBs = []
920 921 922 923 924 925 926
  }

infoCommand  :: CommandUI InfoFlags
infoCommand = CommandUI {
    commandName         = "info",
    commandSynopsis     = "Display detailed information about a particular package.",
    commandDescription  = Nothing,
refold's avatar
refold committed
927
    commandUsage        = usagePackages "info",
928 929 930
    commandDefaultFlags = defaultInfoFlags,
    commandOptions      = \_ -> [
        optionVerbosity infoVerbosity (\v flags -> flags { infoVerbosity = v })
931 932 933 934 935 936

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

937 938 939 940
        ]
  }

instance Monoid InfoFlags where
941 942 943 944
  mempty = InfoFlags {
    infoVerbosity  = mempty,
    infoPackageDBs = mempty
    }
945
  mappend a b = InfoFlags {
946 947
    infoVerbosity  = combine infoVerbosity,
    infoPackageDBs = combine infoPackageDBs
948 949 950
  }
    where combine field = field a `mappend` field b

951 952 953 954
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

955 956
-- | Install takes the same flags as configure along with a few extras.
--
957
data InstallFlags = InstallFlags {
958 959 960
    installDocumentation    :: Flag Bool,
    installHaddockIndex     :: Flag PathTemplate,
    installDryRun           :: Flag Bool,
961 962 963
    installMaxBackjumps     :: Flag Int,
    installReorderGoals     :: Flag Bool,
    installIndependentGoals :: Flag Bool,
964
    installShadowPkgs       :: Flag Bool,
Andres Löh's avatar
Andres Löh committed
965
    installStrongFlags      :: Flag Bool,
966 967
    installReinstall        :: Flag Bool,
    installAvoidReinstalls  :: Flag Bool,
968
    installOverrideReinstall :: Flag Bool,
969 970 971 972 973 974 975
    installUpgradeDeps      :: Flag Bool,
    installOnly             :: Flag Bool,
    installOnlyDeps         :: Flag Bool,
    installRootCmd          :: Flag String,
    installSummaryFile      :: [PathTemplate],
    installLogFile          :: Flag PathTemplate,
    installBuildReports     :: Flag ReportLevel,
976
    installReportPlanningFailure :: Flag Bool,
977
    installSymlinkBinDir    :: Flag FilePath,