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

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

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

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

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

97 98 99 100 101 102
-- ------------------------------------------------------------
-- * Global flags
-- ------------------------------------------------------------

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

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

globalCommand :: CommandUI GlobalFlags
globalCommand = CommandUI {
    commandName         = "",
    commandSynopsis     = "",
131 132 133 134
    commandUsage        = \_ ->
         "This program is the command line interface "
           ++ "to the Haskell Cabal infrastructure.\n"
      ++ "See http://www.haskell.org/cabal/ for more information.\n",
135
    commandDescription  = Just $ \pname ->
136 137 138 139 140 141
         "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",
142 143
    commandDefaultFlags = defaultGlobalFlags,
    commandOptions      = \showOrParseArgs ->
144
      (case showOrParseArgs of ShowArgs -> take 4; ParseArgs -> id)
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
      [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")

160 161 162 163 164 165
      ,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")

166 167 168 169 170 171 172 173 174 175 176 177 178 179
      ,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)
180

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

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

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

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

239 240 241
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

242
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
243
filterConfigureFlags flags cabalLibVersion
244
  | cabalLibVersion >= Version [1,17,0] [] = flags
245 246 247
  | 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
248
  | cabalLibVersion <  Version [1,17,0] [] = flags_1_17_0
249 250 251 252

  -- A no-op that silences the "pattern match is non-exhaustive" warning.
  | otherwise = flags
  where
253 254 255 256
    -- Cabal < 1.17.0 doesn't know about --extra-prog-path and --sysconfdir.
    flags_1_17_0 = flags        { configProgramPathExtra = []
                                , configInstallDirs = configInstallDirs_1_17_0}
    configInstallDirs_1_17_0 = (configInstallDirs flags) { sysconfdir = NoFlag }
257
    -- Cabal < 1.14.0 doesn't know about --disable-benchmarks.
258
    flags_1_14_0 = flags_1_17_0 { configBenchmarks  = NoFlag }
259 260 261 262
    -- Cabal < 1.10.0 doesn't know about --disable-tests.
    flags_1_10_0 = flags_1_14_0 { configTests       = NoFlag }
    -- Cabal < 1.3.10 does not grok the constraints flag.
    flags_1_3_10 = flags_1_10_0 { configConstraints = [] }
263

264 265 266 267 268 269 270 271
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
272
    configExConstraints:: [UserConstraint],
273
    configPreferences  :: [Dependency],
274
    configSolver       :: Flag PreSolver
275 276 277
  }

defaultConfigExFlags :: ConfigExFlags
278
defaultConfigExFlags = mempty { configSolver = Flag defaultSolver }
279 280 281 282 283

configureExCommand :: CommandUI (ConfigFlags, ConfigExFlags)
configureExCommand = configureCommand {
    commandDefaultFlags = (mempty, defaultConfigExFlags),
    commandOptions      = \showOrParseArgs ->
284 285
         liftOptions fst setFst (filter ((/="constraint") . optionName) $
                                 configureOptions   showOrParseArgs)
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
      ++ 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))
301 302 303 304 305 306
  , 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))
307 308 309 310

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
311 312 313 314
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
315 316

  , optionSolver configSolver (\v flags -> flags { configSolver = v })
317 318 319 320 321
  ]

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
322
    configExConstraints= mempty,
323 324
    configPreferences  = mempty,
    configSolver       = mempty
325 326 327
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
328
    configExConstraints= combine configExConstraints,
329 330
    configPreferences  = combine configPreferences,
    configSolver       = combine configSolver
331 332 333
  }
    where combine field = field a `mappend` field b

ttuegel's avatar
ttuegel committed
334 335 336 337
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 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
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildNumJobs  :: Flag (Maybe Int),
  buildOnly     :: Flag SkipAddSourceDepsCheck
}

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
  option "j" ["jobs"]
  "Run NUM jobs simultaneously (or '$ncpus' if no NUM is given)"
  buildNumJobs (\v flags -> flags { buildNumJobs = v })
  (optArg "NUM" (fmap Flag numJobsParser)
   (Flag Nothing)
   (map (Just . maybe "$ncpus" show) . flagToList))

  : option [] ["only"]
  "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 {
    buildNumJobs = mempty,
    buildOnly    = mempty
  }
  mappend a b = BuildExFlags {
    buildNumJobs = combine buildNumJobs,
    buildOnly    = combine buildOnly
  }
    where combine field = field a `mappend` field b

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

testCommand :: CommandUI (TestFlags, BuildExFlags)
testCommand = 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.testCommand

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

benchmarkCommand :: CommandUI (BenchmarkFlags, BuildExFlags)
benchmarkCommand = parent {
  commandDefaultFlags = (commandDefaultFlags parent, mempty),
  commandOptions      =
    \showOrParseArgs -> liftOptions fst setFst
                        (commandOptions parent showOrParseArgs)
                        ++
                        liftOptions snd setSnd (buildExOptions showOrParseArgs)
ttuegel's avatar
ttuegel committed
420
  }
421 422 423 424 425
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

    parent = Cabal.benchmarkCommand
ttuegel's avatar
ttuegel committed
426

427
-- ------------------------------------------------------------
428
-- * Fetch command
429
-- ------------------------------------------------------------
430

431 432 433 434
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
435
      fetchSolver           :: Flag PreSolver,
436 437 438
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
439
      fetchShadowPkgs       :: Flag Bool,
440 441 442 443 444 445 446 447
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
448 449 450 451
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
    fetchReorderGoals     = Flag False,
    fetchIndependentGoals = Flag False,
452
    fetchShadowPkgs       = Flag False,
453 454 455 456
    fetchVerbosity = toFlag normal
   }

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

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
489 490
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
491 492
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
493
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
494

Duncan Coutts's avatar
Duncan Coutts committed
495 496
  }

497 498 499 500
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

501
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
502 503
updateCommand = CommandUI {
    commandName         = "update",
504
    commandSynopsis     = "Updates list of known packages.",
Duncan Coutts's avatar
Duncan Coutts committed
505
    commandDescription  = Nothing,
refold's avatar
refold committed
506
    commandUsage        = usageFlags "update",
507
    commandDefaultFlags = toFlag normal,
508
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
509 510
  }

511
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
512
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
513
    commandName         = "upgrade",
514
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
515
    commandDescription  = Nothing,
refold's avatar
refold committed
516
    commandUsage        = usageFlagsOrPackages "upgrade",
517
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
518
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
519 520
  }

Duncan Coutts's avatar
Duncan Coutts committed
521 522 523 524 525 526 527 528 529 530 531
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

532 533 534
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
535
    commandSynopsis     = "Check the package for common mistakes.",
536 537
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
538
    commandDefaultFlags = toFlag normal,
539
    commandOptions      = \_ -> []
540 541
  }

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

refold's avatar
refold committed
563 564
    progConf = defaultProgramConfiguration

565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
-- ------------------------------------------------------------
-- * 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
583 584 585
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
    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))
      ]
606 607
  }

608 609 610 611 612 613 614 615 616 617 618 619 620
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

621
-- ------------------------------------------------------------
622
-- * Get flags
623 624
-- ------------------------------------------------------------

625 626 627 628 629 630
data GetFlags = GetFlags {
    getDestDir          :: Flag FilePath,
    getPristine         :: Flag Bool,
    getSourceRepository :: Flag (Maybe RepoKind),
    getVerbosity        :: Flag Verbosity
  }
631

632 633 634 635 636 637
defaultGetFlags :: GetFlags
defaultGetFlags = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = toFlag normal
638 639
   }

640 641 642 643
getCommand :: CommandUI GetFlags
getCommand = CommandUI {
    commandName         = "get",
    commandSynopsis     = "Gets a package's source code.",
644 645 646 647 648
    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",
649
    commandUsage        = usagePackages "get",
650 651
    commandDefaultFlags = mempty,
    commandOptions      = \_ -> [
652
        optionVerbosity getVerbosity (\v flags -> flags { getVerbosity = v })
653 654

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

659
       ,option "s" ["source-repository"]
660
         "Copy the package's source repository (ie git clone, darcs get, etc as appropriate)."
661 662 663 664 665 666
         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))

667 668 669
       , option [] ["pristine"]
           ("Unpack the original pristine tarball, rather than updating the "
           ++ ".cabal file with the latest revision from the package archive.")
670
           getPristine (\v flags -> flags { getPristine = v })
671
           trueArg
672 673 674
       ]
  }

675 676 677 678 679 680 681
-- 'cabal unpack' is a deprecated alias for 'cabal get'.
unpackCommand :: CommandUI GetFlags
unpackCommand = getCommand {
  commandName  = "unpack",
  commandUsage = usagePackages "unpack"
  }

682 683 684 685 686 687 688
instance Monoid GetFlags where
  mempty = defaultGetFlags
  mappend a b = GetFlags {
    getDestDir          = combine getDestDir,
    getPristine         = combine getPristine,
    getSourceRepository = combine getSourceRepository,
    getVerbosity        = combine getVerbosity
689 690 691
  }
    where combine field = field a `mappend` field b

692 693 694 695 696 697
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
    listInstalled :: Flag Bool,
698
    listSimpleOutput :: Flag Bool,
699 700 701 702 703 704
    listVerbosity :: Flag Verbosity
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
    listInstalled = Flag False,
705
    listSimpleOutput = Flag False,
706 707 708 709 710 711
    listVerbosity = toFlag normal
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
712
    commandSynopsis     = "List packages matching a search string.",
713
    commandDescription  = Nothing,
refold's avatar
refold committed
714
    commandUsage        = usageFlagsOrPackages "list",
715
    commandDefaultFlags = defaultListFlags,
716
    commandOptions      = \_ -> [
717
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
718

719
        , option [] ["installed"]
720 721 722 723
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

724 725 726 727 728
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

729 730 731 732 733 734 735
        ]
  }

instance Monoid ListFlags where
  mempty = defaultListFlags
  mappend a b = ListFlags {
    listInstalled = combine listInstalled,
736
    listSimpleOutput = combine listSimpleOutput,
737 738 739 740
    listVerbosity = combine listVerbosity
  }
    where combine field = field a `mappend` field b

741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
-- ------------------------------------------------------------
-- * Info flags
-- ------------------------------------------------------------

data InfoFlags = InfoFlags {
    infoVerbosity :: Flag Verbosity
  }

defaultInfoFlags :: InfoFlags
defaultInfoFlags = InfoFlags {
    infoVerbosity = toFlag normal
  }

infoCommand  :: CommandUI InfoFlags
infoCommand = CommandUI {
    commandName         = "info",
    commandSynopsis     = "Display detailed information about a particular package.",
    commandDescription  = Nothing,
refold's avatar
refold committed
759
    commandUsage        = usagePackages "info",
760 761 762 763 764 765 766 767 768 769 770 771 772
    commandDefaultFlags = defaultInfoFlags,
    commandOptions      = \_ -> [
        optionVerbosity infoVerbosity (\v flags -> flags { infoVerbosity = v })
        ]
  }

instance Monoid InfoFlags where
  mempty = defaultInfoFlags
  mappend a b = InfoFlags {
    infoVerbosity = combine infoVerbosity
  }
    where combine field = field a `mappend` field b

773 774 775 776
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

777 778
-- | Install takes the same flags as configure along with a few extras.
--
779
data InstallFlags = InstallFlags {
780 781 782
    installDocumentation    :: Flag Bool,
    installHaddockIndex     :: Flag PathTemplate,
    installDryRun           :: Flag Bool,
783 784 785
    installMaxBackjumps     :: Flag Int,
    installReorderGoals     :: Flag Bool,
    installIndependentGoals :: Flag Bool,
786
    installShadowPkgs       :: Flag Bool,
787 788
    installReinstall        :: Flag Bool,
    installAvoidReinstalls  :: Flag Bool,
789
    installOverrideReinstall :: Flag Bool,
790 791 792 793 794 795 796 797
    installUpgradeDeps      :: Flag Bool,
    installOnly             :: Flag Bool,
    installOnlyDeps         :: Flag Bool,
    installRootCmd          :: Flag String,
    installSummaryFile      :: [PathTemplate],
    installLogFile          :: Flag PathTemplate,
    installBuildReports     :: Flag ReportLevel,
    installSymlinkBinDir    :: Flag FilePath,
798
    installOneShot          :: Flag Bool,
799
    installNumJobs          :: Flag (Maybe Int)
800 801 802 803
  }

defaultInstallFlags :: InstallFlags
defaultInstallFlags = InstallFlags {
804 805 806
    installDocumentation   = Flag False,
    installHaddockIndex    = Flag docIndexFile,
    installDryRun          = Flag False,
807 808 809
    installMaxBackjumps    = Flag defaultMaxBackjumps,
    installReorderGoals    = Flag False,
    installIndependentGoals= Flag False,
810
    installShadowPkgs      = Flag False,
811 812
    installReinstall       = Flag False,
    installAvoidReinstalls = Flag False,
813
    installOverrideReinstall = Flag False,
814 815 816 817 818 819 820 821
    installUpgradeDeps     = Flag False,
    installOnly            = Flag False,
    installOnlyDeps        = Flag False,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = Flag NoReports,
    installSymlinkBinDir   = mempty,
822
    installOneShot         = Flag False,
823
    installNumJobs         = mempty
824
  }
825 826
  where
    docIndexFile = toPathTemplate ("$datadir" </> "doc" </> "index.html")
827

828 829 830
defaultMaxBackjumps :: Int
defaultMaxBackjumps = 200

831 832
defaultSolver :: PreSolver
defaultSolver = Choose
833 834

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

837
installCommand :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
838
installCommand = CommandUI {
839 840
  commandName         = "install",
  commandSynopsis     = "Installs a list of packages.",
refold's avatar
refold committed
841
  commandUsage        = usageFlagsOrPackages "install",
842 843 844 845 846
  commandDescription  = Just $ \pname ->
    let original = case commandDescription configureCommand of
          Just desc -> desc pname ++ "\n"
          Nothing   -> ""
     in original
847
     ++ "Examples:\n"
848 849 850 851 852 853 854 855
     ++ "  " ++ pname ++ " install                 "
     ++ "    Package in the current directory\n"
     ++ "  " ++ pname ++ " install foo             "
     ++ "    Package from the hackage server\n"
     ++ "  " ++ pname ++ " install foo-1.0         "
     ++ "    Specific version of a package\n"
     ++ "  " ++ pname ++ " install 'foo < 2'       "
     ++ "    Constrained package version\n",
856
  commandDefaultFlags = (mempty, mempty, mempty, mempty),
857
  commandOptions      = \showOrParseArgs ->
858 859
       liftOptions get1 set1 (filter ((/="constraint") . optionName) $
                              configureOptions   showOrParseArgs)
860 861
    ++ liftOptions get2 set2 (configureExOptions showOrParseArgs)
    ++ liftOptions get3 set3 (installOptions     showOrParseArgs)
862
    ++ liftOptions get4 set4 (haddockOptions     showOrParseArgs)
863
  }
864
  where
865 866 867 868 869
    get1 (a,_,_,_) = a; set1 a (_,b,c,d) = (a,b,c,d)
    get2 (_,b,_,_) = b; set2 b (a,_,c,d) = (a,b,c,d)
    get3 (_,_,c,_) = c; set3 c (a,b,_,d) = (a,b,c,d)
    get4 (_,_,_,d) = d; set4 d (a,b,c,_) = (a,b,c,d)

870 871 872 873 874 875 876 877 878 879 880 881 882
haddockOptions :: ShowOrParseArgs -> [OptionField HaddockFlags]
haddockOptions showOrParseArgs
  = [ opt { optionName = "haddock-" ++ name,
            optionDescr = [ fmapOptFlags (\(_, lflags) -> ([], map ("haddock-" ++) lflags)) descr
                          | descr <- optionDescr opt] }
    | opt <- commandOptions Cabal.haddockCommand showOrParseArgs
    , let name = optionName opt
    , name `elem` ["hoogle", "html", "html-location",
                   "executables", "internal", "css",
                   "hyperlink-source", "hscolour-css",
                   "contents-location"]
    ]
  where
883 884 885 886 887
    fmapOptFlags :: (OptFlags -> OptFlags) -> OptDescr a -> OptDescr a
    fmapOptFlags modify (ReqArg d f p r w)    = ReqArg d (modify f) p r w
    fmapOptFlags modify (OptArg d f p r i w)  = OptArg d (modify f) p r i w
    fmapOptFlags modify (ChoiceOpt xs)        = ChoiceOpt [(d, modify f, i, w) | (d, f, i, w) <- xs]
    fmapOptFlags modify (BoolOpt d f1 f2 r w) = BoolOpt d (modify f1) (modify f2) r w
888 889 890 891

installOptions ::  ShowOrParseArgs -> [OptionField InstallFlags]
installOptions showOrParseArgs =
      [ option "" ["documentation"]
892 893 894 895
          "building of documentation"
          installDocumentation (\v flags -> flags { installDocumentation = v })
          (boolOpt [] [])

896 897
      , option [] ["doc-index-file"]
          "A central index of haddock API documentation (template cannot use $pkgid)"
898 899 900
          installHaddockIndex (\v flags -> flags { installHaddockIndex = v })
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
901

902
      , option [] ["dry-run"]
903 904 905
          "Do not install anything, only print what would be installed."
          installDryRun (\v flags -> flags { installDryRun = v })
          trueArg
906
      ] ++
907

908 909
      optionSolverFlags showOrParseArgs
                        installMaxBackjumps     (\v flags -> flags { installMaxBackjumps     = v })
910
                        installReorderGoals     (\v flags -> flags { installReorderGoals     = v })
911 912
                        installIndependentGoals (\v flags -> flags { installIndependentGoals = v })
                        installShadowPkgs       (\v flags -> flags { installShadowPkgs       = v }) ++
913

914
      [ option [] ["reinstall"]
915 916
          "Install even if it means installing the same version again."
          installReinstall (\v flags -> flags { installReinstall = v })
917
          (yesNoOpt showOrParseArgs)
918

919 920 921
      , option [] ["avoid-reinstalls"]
          "Do not select versions that would destructively overwrite installed packages."
          installAvoidReinstalls (\v flags -> flags { installAvoidReinstalls = v })
922
          (yesNoOpt showOrParseArgs)
923

924
      , option [] ["force-reinstalls"]
925
          "Reinstall packages even if they will most likely break other installed packages."
926
          installOverrideReinstall (\v flags -> flags { installOverrideReinstall = v })
927
          (yesNoOpt showOrParseArgs)
928

929 930 931
      , option [] ["upgrade-dependencies"]
          "Pick the latest version for all dependencies, rather than trying to pick an installed version."
          installUpgradeDeps (\v flags -> flags { installUpgradeDeps = v })
932
          (yesNoOpt showOrParseArgs)
933

934 935 936
      , option [] ["only-dependencies"]
          "Install only the dependencies necessary to build the given packages"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
937
          (yesNoOpt showOrParseArgs)
938

939 940 941 942 943
      , option [] ["dependencies-only"]
          "A synonym for --only-dependencies"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
          (yesNoOpt showOrParseArgs)

944 945 946 947 948
      , option [] ["root-cmd"]
          "Command used to gain root privileges, when installing with --global."
          installRootCmd (\v flags -> flags { installRootCmd = v })
          (reqArg' "COMMAND" toFlag flagToList)

949 950 951 952 953
      , option [] ["symlink-bindir"]
          "Add symlinks to installed executables into this directory."
           installSymlinkBinDir (\v flags -> flags { installSymlinkBinDir = v })
           (reqArgFlag "DIR")

954 955 956 957 958 959
      , option [] ["build-summary"]
          "Save build summaries to file (name template can use $pkgid, $compiler, $os, $arch)"
          installSummaryFile (\v flags -> flags { installSummaryFile = v })
          (reqArg' "TEMPLATE" (\x -> [toPathTemplate x]) (map fromPathTemplate))

      , option [] ["build-log"]
Duncan Coutts's avatar
Duncan Coutts committed
960 961
          "Log all builds to file (name template can use $pkgid, $compiler, $os, $arch)"
          installLogFile (\v flags -> flags { installLogFile = v })
962 963
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
Duncan Coutts's avatar
Duncan Coutts committed
964

965 966
      , option [] ["remote-build-reporting"]
          "Generate build reports to send to a remote server (none, anonymous or detailed)."
967
          installBuildReports (\v flags -> flags { installBuildReports = v })
968 969 970 971
          (reqArg "LEVEL" (readP_to_E (const $ "report level must be 'none', "
                                            ++ "'anonymous' or 'detailed'")
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))
972

973 974 975
      , option [] ["one-shot"]
          "Do not record the packages in the world file."
          installOneShot (\v flags -> flags { installOneShot = v })
976
          (yesNoOpt showOrParseArgs)
977 978

      , option "j" ["jobs"]
979
        "Run NUM jobs simultaneously (or '$ncpus' if no NUM is given)."
980
        installNumJobs (\v flags -> flags { installNumJobs = v })
981
        (optArg "NUM" (fmap Flag numJobsParser)
982
                      (Flag Nothing)
983
                      (map (Just . maybe "$ncpus" show) . flagToList))
984 985
      ] ++ case showOrParseArgs of      -- TODO: remove when "cabal install"
                                        -- avoids
986
          ParseArgs ->
EyalLotem's avatar
EyalLotem committed
987
            [ option [] ["only"]
988 989
              "Only installs the package in the current directory."
              installOnly (\v flags -> flags { installOnly = v })
EyalLotem's avatar
EyalLotem committed
990
              trueArg ]
991
          _ -> []
992

993 994

instance Monoid InstallFlags where
995
  mempty = InstallFlags {
996 997 998 999 1000
    installDocumentation   = mempty,
    installHaddockIndex    = mempty,
    installDryRun          = mempty,
    installReinstall       = mempty,
    installAvoidReinstalls = mempty,
1001
    installOverrideReinstall = mempty,
Andres Löh's avatar
Andres Löh committed
1002
    installMaxBackjumps    = mempty,
1003
    installUpgradeDeps     = mempty,
Andres Löh's avatar
Andres Löh committed
1004
    installReorderGoals    = mempty,
1005
    installIndependentGoals= mempty,
1006
    installShadowPkgs      = mempty,
1007 1008 1009 1010 1011 1012 1013
    installOnly            = mempty,
    installOnlyDeps        = mempty,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = mempty,
    installSymlinkBinDir   = mempty,
1014
    installOneShot         = mempty,