Setup.hs 71.5 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
  | otherwise = flags_latest
280
  where
281
    -- Cabal >= 1.19.1 uses '--dependency' and does not need '--constraint'.
282 283
    flags_latest = flags        { configConstraints = [] }

284 285 286 287 288
    -- 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 }
289
    -- Cabal < 1.18.0 doesn't know about --extra-prog-path and --sysconfdir.
290
    flags_1_18_0 = flags_1_19_0 { configProgramPathExtra = toNubList []
291 292
                                , configInstallDirs = configInstallDirs_1_18_0}
    configInstallDirs_1_18_0 = (configInstallDirs flags) { sysconfdir = NoFlag }
293
    -- Cabal < 1.14.0 doesn't know about '--disable-benchmarks'.
294
    flags_1_14_0 = flags_1_18_0 { configBenchmarks  = NoFlag }
295
    -- Cabal < 1.10.0 doesn't know about '--disable-tests'.
296
    flags_1_10_0 = flags_1_14_0 { configTests       = NoFlag }
297
    -- Cabal < 1.3.10 does not grok the '--constraints' flag.
298
    flags_1_3_10 = flags_1_10_0 { configConstraints = [] }
299

300 301 302 303 304 305 306 307
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

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

defaultConfigExFlags :: ConfigExFlags
315 316
defaultConfigExFlags = mempty { configSolver     = Flag defaultSolver
                              , configAllowNewer = Flag AllowNewerNone }
317 318 319 320 321

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

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

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

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

364
  ]
cheecheeo's avatar
cheecheeo committed
365
  where allowNewerArgument = "DEPS"
366 367 368 369

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

ttuegel's avatar
ttuegel committed
384 385 386 387
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

388 389 390 391 392 393 394 395 396 397
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
}

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
398
  option [] ["only"]
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 426 427 428 429
  "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

-- ------------------------------------------------------------
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
-- * 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

448 449 450 451
-- ------------------------------------------------------------
-- * Test command
-- ------------------------------------------------------------

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

470 471
    parent   = Cabal.testCommand
    progConf = defaultProgramConfiguration
472 473 474 475 476

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

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

495 496
    parent   = Cabal.benchmarkCommand
    progConf = defaultProgramConfiguration
ttuegel's avatar
ttuegel committed
497

498
-- ------------------------------------------------------------
499
-- * Fetch command
500
-- ------------------------------------------------------------
501

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

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

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

       ] ++

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

Duncan Coutts's avatar
Duncan Coutts committed
569 570
  }

571 572 573 574 575 576
-- ------------------------------------------------------------
-- * Freeze command
-- ------------------------------------------------------------

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

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

617 618 619 620 621 622 623 624 625 626
       , 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 [] [])

627 628 629 630 631 632 633 634
       ] ++

       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
635
                         freezeStrongFlags      (\v flags -> flags { freezeStrongFlags      = v })
636 637 638

  }

639 640 641 642
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

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

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

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

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

684 685 686 687 688 689 690 691 692 693
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      = \_ -> []
  }

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

715
    parent = Cabal.buildCommand defaultProgramConfiguration
refold's avatar
refold committed
716

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

760 761 762 763 764 765 766 767 768 769 770 771 772
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

773
-- ------------------------------------------------------------
774
-- * Get flags
775 776
-- ------------------------------------------------------------

777 778 779 780 781 782
data GetFlags = GetFlags {
    getDestDir          :: Flag FilePath,
    getPristine         :: Flag Bool,
    getSourceRepository :: Flag (Maybe RepoKind),
    getVerbosity        :: Flag Verbosity
  }
783

784 785 786 787 788 789
defaultGetFlags :: GetFlags
defaultGetFlags = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = toFlag normal
790 791
   }

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

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

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

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

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

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

849 850 851 852 853
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
854
    listInstalled    :: Flag Bool,
855
    listSimpleOutput :: Flag Bool,
856 857
    listVerbosity    :: Flag Verbosity,
    listPackageDBs   :: [Maybe PackageDB]
858 859 860 861
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
862
    listInstalled    = Flag False,
863
    listSimpleOutput = Flag False,
864 865
    listVerbosity    = toFlag normal,
    listPackageDBs   = []
866 867 868 869 870
  }

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

878
        , option [] ["installed"]
879 880 881 882
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

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

888 889 890 891 892
        , 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)

893 894 895 896
        ]
  }

instance Monoid ListFlags where
897 898 899 900 901 902
  mempty = ListFlags {
    listInstalled    = mempty,
    listSimpleOutput = mempty,
    listVerbosity    = mempty,
    listPackageDBs   = mempty
    }
903
  mappend a b = ListFlags {
904
    listInstalled    = combine listInstalled,
905
    listSimpleOutput = combine listSimpleOutput,
906 907
    listVerbosity    = combine listVerbosity,
    listPackageDBs   = combine listPackageDBs