Setup.hs 79.2 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
import Distribution.Simple.Utils
90
         ( wrapText, wrapLine )
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
  }

globalCommand :: CommandUI GlobalFlags
globalCommand = CommandUI {
    commandName         = "",
144 145
    commandSynopsis     =
         "Command line interface to the Haskell Cabal infrastructure.",
146
    commandUsage        = \_ ->
147
         "See http://www.haskell.org/cabal/ for more information.\n",
148
    commandDescription  = Just $ \pname ->
149
         "For more information about a command use:\n"
150 151 152 153
      ++ "  " ++ pname ++ " COMMAND --help\n"
      ++ "or\n"
      ++ "  " ++ pname ++ " help COMMAND\n"
      ++ "\n"
154
      ++ "To install Cabal packages from hackage use:\n"
155 156
      ++ "  " ++ pname ++ " install foo [--dry-run]\n"
      ++ "\n"
157 158
      ++ "Occasionally you need to update the list of available packages:\n"
      ++ "  " ++ pname ++ " update\n",
159
    commandNotes = Nothing,
160
    commandDefaultFlags = mempty,
161
    commandOptions      = \showOrParseArgs ->
162
      (case showOrParseArgs of ShowArgs -> take 6; ParseArgs -> id)
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
      [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")

178 179 180 181 182 183
      ,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")

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

189 190 191 192 193
      ,option [] ["ignore-sandbox"]
         "Ignore any existing sandbox"
         globalIgnoreSandbox (\v flags -> flags { globalIgnoreSandbox = v })
         trueArg

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

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

209 210 211 212 213
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

214 215 216 217
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
218 219 220 221 222
      ]
  }

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

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

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

266
configureCommand :: CommandUI ConfigFlags
267
configureCommand = (Cabal.configureCommand defaultProgramConfiguration) {
268
    commandDefaultFlags = mempty
Duncan Coutts's avatar
Duncan Coutts committed
269 270
  }

271 272 273
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

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

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

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

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

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

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

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

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

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

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

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

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

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

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
}

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
402
  option [] ["only"]
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 433
  "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

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

452 453 454 455
-- ------------------------------------------------------------
-- * Test command
-- ------------------------------------------------------------

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

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

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

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

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

502
-- ------------------------------------------------------------
503
-- * Fetch command
504
-- ------------------------------------------------------------
505

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

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

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
534 535
fetchCommand = CommandUI {
    commandName         = "fetch",
536
    commandSynopsis     = "Downloads packages for later installation.",
537 538 539 540 541
    commandUsage        = usageAlternatives "fetch" [ "[FLAGS] PACKAGES"
                                                    ],
    commandDescription  = Just $ \_ ->
          "Note that it currently is not possible to fetch the dependencies for a\n"
       ++ "package in the current directory.\n",
542
    commandNotes        = Nothing,
543
    commandDefaultFlags = defaultFetchFlags,
544
    commandOptions      = \ showOrParseArgs -> [
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
         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
566 567 568 569

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
570 571
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
572 573
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
574
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
Andres Löh's avatar
Andres Löh committed
575
                         fetchStrongFlags      (\v flags -> flags { fetchStrongFlags      = v })
576

Duncan Coutts's avatar
Duncan Coutts committed
577 578
  }

579 580 581 582 583 584
-- ------------------------------------------------------------
-- * Freeze command
-- ------------------------------------------------------------

data FreezeFlags = FreezeFlags {
      freezeDryRun           :: Flag Bool,
585 586
      freezeTests            :: Flag Bool,
      freezeBenchmarks       :: Flag Bool,
587 588 589 590 591
      freezeSolver           :: Flag PreSolver,
      freezeMaxBackjumps     :: Flag Int,
      freezeReorderGoals     :: Flag Bool,
      freezeIndependentGoals :: Flag Bool,
      freezeShadowPkgs       :: Flag Bool,
Andres Löh's avatar
Andres Löh committed
592
      freezeStrongFlags      :: Flag Bool,
593 594 595 596 597 598
      freezeVerbosity        :: Flag Verbosity
    }

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

freezeCommand :: CommandUI FreezeFlags
freezeCommand = CommandUI {
    commandName         = "freeze",
    commandSynopsis     = "Freeze dependencies.",
614 615 616 617 618 619 620 621
    commandDescription  = Just $ \_ -> wrapText $
         "Calculates a valid set of dependencies and their exact versions. "
      ++ "If successful, saves the result to the file `cabal.config`.\n"
      ++ "\n"
      ++ "The package versions specified in `cabal.config` will be used for "
      ++ "any future installs.\n"
      ++ "\n"
      ++ "An existing `cabal.config` is ignored and overwritten.\n",
622
    commandNotes        = Nothing,
623 624 625
    commandUsage        = usageAlternatives "freeze" [""
                                                     ,"PACKAGES"
                                                     ],
626 627 628 629 630 631 632 633 634
    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

635 636 637 638 639 640 641 642 643 644
       , 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 [] [])

645 646 647 648 649 650 651 652
       ] ++

       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
653
                         freezeStrongFlags      (\v flags -> flags { freezeStrongFlags      = v })
654 655 656

  }

657 658 659 660
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

661
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
662 663
updateCommand = CommandUI {
    commandName         = "update",
664
    commandSynopsis     = "Updates list of known packages.",
665 666 667
    commandDescription  = Just $ \_ ->
      "For all known remote repositories, download the package list.\n",
    commandNotes        = Just $ \_ ->
668 669 670
      relevantConfigValuesText ["remote-repo"
                               ,"remote-repo-cache"
                               ,"local-repo"],
refold's avatar
refold committed
671
    commandUsage        = usageFlags "update",
672
    commandDefaultFlags = toFlag normal,
673
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
674 675
  }

676
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
677
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
678
    commandName         = "upgrade",
679
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
680
    commandDescription  = Nothing,
refold's avatar
refold committed
681
    commandUsage        = usageFlagsOrPackages "upgrade",
682
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
683
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
684 685
  }

Duncan Coutts's avatar
Duncan Coutts committed
686 687 688 689 690 691 692 693 694 695 696
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

697 698 699
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
700
    commandSynopsis     = "Check the package for common mistakes.",
701 702 703 704 705 706
    commandDescription  = Just $ \_ -> wrapText $
         "Expects a .cabal package file in the current directory.\n"
      ++ "\n"
      ++ "The checks correspond to the requirements to packages on Hackage. "
      ++ "If no errors and warnings are reported, Hackage will accept this "
      ++ "package.\n",
707
    commandNotes        = Nothing,
708
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
709
    commandDefaultFlags = toFlag normal,
710
    commandOptions      = \_ -> []
711 712
  }

713 714 715 716 717
formatCommand  :: CommandUI (Flag Verbosity)
formatCommand = CommandUI {
    commandName         = "format",
    commandSynopsis     = "Reformat the .cabal file using the standard style.",
    commandDescription  = Nothing,
718
    commandNotes        = Nothing,
719
    commandUsage        = usageAlternatives "format" ["[FILE]"],
720 721 722 723
    commandDefaultFlags = toFlag normal,
    commandOptions      = \_ -> []
  }

724
runCommand :: CommandUI (BuildFlags, BuildExFlags)
refold's avatar
refold committed
725 726
runCommand = CommandUI {
    commandName         = "run",
727 728 729 730 731
    commandSynopsis     = "Builds and runs an executable.",
    commandDescription  = Just $ \_ -> wrapText $
         "Builds and then runs the specified executable. If no executable is "
      ++ "specified, but the package contains just one executable, that one "
      ++ "is built and executed.\n",
732
    commandNotes        = Nothing,
733 734
    commandUsage        = usageAlternatives "run"
        ["[FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]"],
refold's avatar
refold committed
735
    commandDefaultFlags = mempty,
736 737
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
738
                          (commandOptions parent showOrParseArgs)
739 740 741
                          ++
                          liftOptions snd setSnd
                          (buildExOptions showOrParseArgs)
refold's avatar
refold committed
742 743
  }
  where
744 745 746
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

747
    parent = Cabal.buildCommand defaultProgramConfiguration
refold's avatar
refold committed
748

749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
-- ------------------------------------------------------------
-- * 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
767 768 769
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
770 771
    commandDescription  = Nothing,
    commandNotes        = Just $ \_ ->
772
         "You can store your Hackage login in the ~/.cabal/config file\n",
773
    commandUsage        = usageAlternatives "report" ["[FLAGS]"],
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
    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))
      ]
790 791
  }

792 793 794 795 796 797 798 799 800 801 802 803 804
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

805
-- ------------------------------------------------------------
806
-- * Get flags
807 808
-- ------------------------------------------------------------

809 810 811 812 813 814
data GetFlags = GetFlags {
    getDestDir          :: Flag FilePath,
    getPristine         :: Flag Bool,
    getSourceRepository :: Flag (Maybe RepoKind),
    getVerbosity        :: Flag Verbosity
  }
815

816 817 818 819 820 821
defaultGetFlags :: GetFlags
defaultGetFlags = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = toFlag normal
822 823
   }

824 825 826
getCommand :: CommandUI GetFlags
getCommand = CommandUI {
    commandName         = "get",
827 828
    commandSynopsis     = "Download/Extract a package's source code (repository).",
    commandDescription  = Just $ \_ -> wrapText $
829 830 831 832
          "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",
833
    commandNotes        = Nothing,
834
    commandUsage        = usagePackages "get",
835
    commandDefaultFlags = defaultGetFlags,
836
    commandOptions      = \_ -> [
837
        optionVerbosity getVerbosity (\v flags -> flags { getVerbosity = v })
838 839

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

844
       ,option "s" ["source-repository"]
845
         "Copy the package's source repository (ie git clone, darcs get, etc as appropriate)."
846 847 848 849 850 851
         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))

852 853 854
       , option [] ["pristine"]
           ("Unpack the original pristine tarball, rather than updating the "
           ++ ".cabal file with the latest revision from the package archive.")
855
           getPristine (\v flags -> flags { getPristine = v })
856
           trueArg
857 858 859
       ]
  }

860 861 862 863 864 865 866
-- 'cabal unpack' is a deprecated alias for 'cabal get'.
unpackCommand :: CommandUI GetFlags
unpackCommand = getCommand {
  commandName  = "unpack",
  commandUsage = usagePackages "unpack"
  }

867
instance Monoid GetFlags where
868 869 870 871 872 873
  mempty = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = mempty
    }
874 875 876 877 878
  mappend a b = GetFlags {
    getDestDir          = combine getDestDir,
    getPristine         = combine getPristine,
    getSourceRepository = combine getSourceRepository,
    getVerbosity        = combine getVerbosity
879 880 881
  }
    where combine field = field a `mappend` field b

882 883 884 885 886
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
887
    listInstalled    :: Flag Bool,
888
    listSimpleOutput :: Flag Bool,
889 890
    listVerbosity    :: Flag Verbosity,
    listPackageDBs   :: [Maybe PackageDB]
891 892 893 894
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
895
    listInstalled    = Flag False,
896
    listSimpleOutput = Flag False,
897 898
    listVerbosity    = toFlag normal,
    listPackageDBs   = []
899 900 901 902 903
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
904
    commandSynopsis     = "List packages matching a search string.",
905 906 907 908 909 910 911 912
    commandDescription  = Just $ \_ -> wrapText $
         "List all packages, or all packages matching one of the search"
      ++ " strings.\n"
      ++ "\n"
      ++ "If there is a sandbox in the current directory and "
      ++ "config:ignore-sandbox is False, use the sandbox package database. "
      ++ "Otherwise, use the package database specified with --package-db. "
      ++ "If not specified, use the user package database.\n",
913
    commandNotes        = Nothing,
914 915
    commandUsage        = usageAlternatives "list" [ "[FLAGS]"
                                                   , "[FLAGS] STRINGS"],
916
    commandDefaultFlags = defaultListFlags,
917
    commandOptions      = \_ -> [
918
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
919

920
        , option [] ["installed"]
921 922 923 924
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

925 926 927 928 929
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput