Setup.hs 57.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 Distribution.Client.Sandbox.Types
         ( UseSandbox(..) )
50 51
import qualified Distribution.Client.Init.Types as IT
         ( InitFlags(..), PackageType(..) )
52 53
import Distribution.Client.Targets
         ( UserConstraint, readUserConstraint )
54 55 56

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

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

98 99 100 101 102 103 104 105 106
-- ------------------------------------------------------------
-- * Global flags
-- ------------------------------------------------------------

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

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

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

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

174 175 176 177 178
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

179 180 181 182
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
183 184 185 186 187 188 189 190 191 192
      ]
  }

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

225
configureCommand :: CommandUI ConfigFlags
226
configureCommand = (Cabal.configureCommand defaultProgramConfiguration) {
227
    commandDefaultFlags = mempty
Duncan Coutts's avatar
Duncan Coutts committed
228 229
  }

230 231 232
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

233
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
234
filterConfigureFlags flags cabalLibVersion
235 236 237 238 239 240 241 242 243 244 245 246 247 248
  | cabalLibVersion >= Version [1,14,0] [] = flags
  | 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

  -- A no-op that silences the "pattern match is non-exhaustive" warning.
  | otherwise = flags
  where
    -- Cabal < 1.14.0 doesn't know about --disable-benchmarks.
    flags_1_14_0 = flags        { configBenchmarks  = NoFlag }
    -- 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 = [] }
249

250 251 252 253 254 255 256 257
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
258
    configExConstraints:: [UserConstraint],
259
    configPreferences  :: [Dependency],
260
    configSolver       :: Flag PreSolver
261 262 263
  }

defaultConfigExFlags :: ConfigExFlags
264
defaultConfigExFlags = mempty { configSolver = Flag defaultSolver }
265 266 267 268 269

configureExCommand :: CommandUI (ConfigFlags, ConfigExFlags)
configureExCommand = configureCommand {
    commandDefaultFlags = (mempty, defaultConfigExFlags),
    commandOptions      = \showOrParseArgs ->
270 271
         liftOptions fst setFst (filter ((/="constraint") . optionName) $
                                 configureOptions   showOrParseArgs)
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
      ++ 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))
287 288 289 290 291 292
  , 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))
293 294 295 296

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
297 298 299 300
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
301 302

  , optionSolver configSolver (\v flags -> flags { configSolver = v })
303 304 305 306 307
  ]

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
308
    configExConstraints= mempty,
309 310
    configPreferences  = mempty,
    configSolver       = mempty
311 312 313
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
314
    configExConstraints= combine configExConstraints,
315 316
    configPreferences  = combine configPreferences,
    configSolver       = combine configSolver
317 318 319
  }
    where combine field = field a `mappend` field b

ttuegel's avatar
ttuegel committed
320 321 322 323
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

324 325 326 327 328 329 330 331 332 333 334 335 336 337 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
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
406
  }
407 408 409 410 411
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

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

413
-- ------------------------------------------------------------
414
-- * Fetch command
415
-- ------------------------------------------------------------
416

417 418 419 420
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
421
      fetchSolver           :: Flag PreSolver,
422 423 424
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
425
      fetchShadowPkgs       :: Flag Bool,
426 427 428 429 430 431 432 433
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
434 435 436 437
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
    fetchReorderGoals     = Flag False,
    fetchIndependentGoals = Flag False,
438
    fetchShadowPkgs       = Flag False,
439 440 441 442
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
443 444
fetchCommand = CommandUI {
    commandName         = "fetch",
445
    commandSynopsis     = "Downloads packages for later installation.",
Duncan Coutts's avatar
Duncan Coutts committed
446
    commandDescription  = Nothing,
refold's avatar
refold committed
447
    commandUsage        = usagePackages "fetch",
448
    commandDefaultFlags = defaultFetchFlags,
449
    commandOptions      = \ showOrParseArgs -> [
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
         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
471 472 473 474

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
475 476
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
477 478
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
479
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
480

Duncan Coutts's avatar
Duncan Coutts committed
481 482
  }

483 484 485 486
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

487
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
488 489 490 491
updateCommand = CommandUI {
    commandName         = "update",
    commandSynopsis     = "Updates list of known packages",
    commandDescription  = Nothing,
refold's avatar
refold committed
492
    commandUsage        = usageFlags "update",
493
    commandDefaultFlags = toFlag normal,
494
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
495 496
  }

497
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
498
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
499
    commandName         = "upgrade",
500
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
501
    commandDescription  = Nothing,
refold's avatar
refold committed
502
    commandUsage        = usageFlagsOrPackages "upgrade",
503
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
504
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
505 506
  }

Duncan Coutts's avatar
Duncan Coutts committed
507 508 509 510 511 512 513 514 515 516 517
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

518 519 520 521 522 523
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
    commandSynopsis     = "Check the package for common mistakes",
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
524
    commandDefaultFlags = toFlag normal,
525
    commandOptions      = \_ -> []
526 527
  }

528
runCommand :: CommandUI (BuildFlags, BuildExFlags)
refold's avatar
refold committed
529 530 531 532 533
runCommand = CommandUI {
    commandName         = "run",
    commandSynopsis     = "Runs the compiled executable.",
    commandDescription  = Nothing,
    commandUsage        =
534 535 536
      \pname -> "Usage: " ++ pname
                ++ " run [FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]\n\n"
                ++ "Flags for run:",
refold's avatar
refold committed
537
    commandDefaultFlags = mempty,
538 539 540 541 542 543
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
                          (Cabal.buildOptions progConf showOrParseArgs)
                          ++
                          liftOptions snd setSnd
                          (buildExOptions showOrParseArgs)
refold's avatar
refold committed
544 545
  }
  where
546 547 548
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

refold's avatar
refold committed
549 550
    progConf = defaultProgramConfiguration

551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
-- ------------------------------------------------------------
-- * 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
569 570 571
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
    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))
      ]
592 593
  }

594 595 596 597 598 599 600 601 602 603 604 605 606
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

607
-- ------------------------------------------------------------
608
-- * Get flags
609 610
-- ------------------------------------------------------------

611 612 613 614 615 616
data GetFlags = GetFlags {
    getDestDir          :: Flag FilePath,
    getPristine         :: Flag Bool,
    getSourceRepository :: Flag (Maybe RepoKind),
    getVerbosity        :: Flag Verbosity
  }
617

618 619 620 621 622 623
defaultGetFlags :: GetFlags
defaultGetFlags = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = toFlag normal
624 625
   }

626 627 628 629
getCommand :: CommandUI GetFlags
getCommand = CommandUI {
    commandName         = "get",
    commandSynopsis     = "Gets a package's source code.",
630
    commandDescription  = Nothing,
631
    commandUsage        = usagePackages "get",
632 633
    commandDefaultFlags = mempty,
    commandOptions      = \_ -> [
634
        optionVerbosity getVerbosity (\v flags -> flags { getVerbosity = v })
635 636

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

641
       ,option "s" ["source-repository"]
refold's avatar
refold committed
642
         "Fork the package's source repository."
643 644 645 646 647 648
         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))

649 650 651
       , option [] ["pristine"]
           ("Unpack the original pristine tarball, rather than updating the "
           ++ ".cabal file with the latest revision from the package archive.")
652
           getPristine (\v flags -> flags { getPristine = v })
653
           trueArg
654 655 656
       ]
  }

657 658 659 660 661 662 663
-- 'cabal unpack' is a deprecated alias for 'cabal get'.
unpackCommand :: CommandUI GetFlags
unpackCommand = getCommand {
  commandName  = "unpack",
  commandUsage = usagePackages "unpack"
  }

664 665 666 667 668 669 670
instance Monoid GetFlags where
  mempty = defaultGetFlags
  mappend a b = GetFlags {
    getDestDir          = combine getDestDir,
    getPristine         = combine getPristine,
    getSourceRepository = combine getSourceRepository,
    getVerbosity        = combine getVerbosity
671 672 673
  }
    where combine field = field a `mappend` field b

674 675 676 677 678 679
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
    listInstalled :: Flag Bool,
680
    listSimpleOutput :: Flag Bool,
681 682 683 684 685 686
    listVerbosity :: Flag Verbosity
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
    listInstalled = Flag False,
687
    listSimpleOutput = Flag False,
688 689 690 691 692 693
    listVerbosity = toFlag normal
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
694
    commandSynopsis     = "List packages matching a search string.",
695
    commandDescription  = Nothing,
refold's avatar
refold committed
696
    commandUsage        = usageFlagsOrPackages "list",
697
    commandDefaultFlags = defaultListFlags,
698
    commandOptions      = \_ -> [
699
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
700

701
        , option [] ["installed"]
702 703 704 705
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

706 707 708 709 710
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

711 712 713 714 715 716 717
        ]
  }

instance Monoid ListFlags where
  mempty = defaultListFlags
  mappend a b = ListFlags {
    listInstalled = combine listInstalled,
718
    listSimpleOutput = combine listSimpleOutput,
719 720 721 722
    listVerbosity = combine listVerbosity
  }
    where combine field = field a `mappend` field b

723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
-- ------------------------------------------------------------
-- * 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
741
    commandUsage        = usagePackages "info",
742 743 744 745 746 747 748 749 750 751 752 753 754
    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

755 756 757 758
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

759 760
-- | Install takes the same flags as configure along with a few extras.
--
761
data InstallFlags = InstallFlags {
762 763 764
    installDocumentation    :: Flag Bool,
    installHaddockIndex     :: Flag PathTemplate,
    installDryRun           :: Flag Bool,
765 766 767
    installMaxBackjumps     :: Flag Int,
    installReorderGoals     :: Flag Bool,
    installIndependentGoals :: Flag Bool,
768
    installShadowPkgs       :: Flag Bool,
769 770
    installReinstall        :: Flag Bool,
    installAvoidReinstalls  :: Flag Bool,
771
    installOverrideReinstall :: Flag Bool,
772 773 774 775 776 777 778 779
    installUpgradeDeps      :: Flag Bool,
    installOnly             :: Flag Bool,
    installOnlyDeps         :: Flag Bool,
    installRootCmd          :: Flag String,
    installSummaryFile      :: [PathTemplate],
    installLogFile          :: Flag PathTemplate,
    installBuildReports     :: Flag ReportLevel,
    installSymlinkBinDir    :: Flag FilePath,
780
    installOneShot          :: Flag Bool,
781 782
    installNumJobs          :: Flag (Maybe Int),
    installUseSandbox       :: UseSandbox
783 784 785 786
  }

defaultInstallFlags :: InstallFlags
defaultInstallFlags = InstallFlags {
787 788 789
    installDocumentation   = Flag False,
    installHaddockIndex    = Flag docIndexFile,
    installDryRun          = Flag False,
790 791 792
    installMaxBackjumps    = Flag defaultMaxBackjumps,
    installReorderGoals    = Flag False,
    installIndependentGoals= Flag False,
793
    installShadowPkgs      = Flag False,
794 795
    installReinstall       = Flag False,
    installAvoidReinstalls = Flag False,
796
    installOverrideReinstall = Flag False,
797 798 799 800 801 802 803 804
    installUpgradeDeps     = Flag False,
    installOnly            = Flag False,
    installOnlyDeps        = Flag False,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = Flag NoReports,
    installSymlinkBinDir   = mempty,
805
    installOneShot         = Flag False,
806 807
    installNumJobs         = mempty,
    installUseSandbox      = mempty
808
  }
809 810
  where
    docIndexFile = toPathTemplate ("$datadir" </> "doc" </> "index.html")
811

812 813 814
defaultMaxBackjumps :: Int
defaultMaxBackjumps = 200

815 816
defaultSolver :: PreSolver
defaultSolver = Choose
817 818

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

821
installCommand :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
822
installCommand = CommandUI {
823 824
  commandName         = "install",
  commandSynopsis     = "Installs a list of packages.",
refold's avatar
refold committed
825
  commandUsage        = usageFlagsOrPackages "install",
826 827 828 829 830
  commandDescription  = Just $ \pname ->
    let original = case commandDescription configureCommand of
          Just desc -> desc pname ++ "\n"
          Nothing   -> ""
     in original
831
     ++ "Examples:\n"
832 833 834 835 836 837 838 839
     ++ "  " ++ 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",
840
  commandDefaultFlags = (mempty, mempty, mempty, mempty),
841
  commandOptions      = \showOrParseArgs ->
842 843
       liftOptions get1 set1 (filter ((/="constraint") . optionName) $
                              configureOptions   showOrParseArgs)
844 845
    ++ liftOptions get2 set2 (configureExOptions showOrParseArgs)
    ++ liftOptions get3 set3 (installOptions     showOrParseArgs)
846
    ++ liftOptions get4 set4 (haddockOptions     showOrParseArgs)
847
  }
848
  where
849 850 851 852 853
    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)

854 855 856 857 858 859 860 861 862 863 864 865 866
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
867 868 869 870 871
    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
872 873 874 875

installOptions ::  ShowOrParseArgs -> [OptionField InstallFlags]
installOptions showOrParseArgs =
      [ option "" ["documentation"]
876 877 878 879
          "building of documentation"
          installDocumentation (\v flags -> flags { installDocumentation = v })
          (boolOpt [] [])

880 881
      , option [] ["doc-index-file"]
          "A central index of haddock API documentation (template cannot use $pkgid)"
882 883 884
          installHaddockIndex (\v flags -> flags { installHaddockIndex = v })
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
885

886
      , option [] ["dry-run"]
887 888 889
          "Do not install anything, only print what would be installed."
          installDryRun (\v flags -> flags { installDryRun = v })
          trueArg
890
      ] ++
891

892 893
      optionSolverFlags showOrParseArgs
                        installMaxBackjumps     (\v flags -> flags { installMaxBackjumps     = v })
894
                        installReorderGoals     (\v flags -> flags { installReorderGoals     = v })
895 896
                        installIndependentGoals (\v flags -> flags { installIndependentGoals = v })
                        installShadowPkgs       (\v flags -> flags { installShadowPkgs       = v }) ++
897

898
      [ option [] ["reinstall"]
899 900
          "Install even if it means installing the same version again."
          installReinstall (\v flags -> flags { installReinstall = v })
901
          (yesNoOpt showOrParseArgs)
902

903 904 905
      , option [] ["avoid-reinstalls"]
          "Do not select versions that would destructively overwrite installed packages."
          installAvoidReinstalls (\v flags -> flags { installAvoidReinstalls = v })
906
          (yesNoOpt showOrParseArgs)
907

908
      , option [] ["force-reinstalls"]
909
          "Reinstall packages even if they will most likely break other installed packages."
910
          installOverrideReinstall (\v flags -> flags { installOverrideReinstall = v })
911
          (yesNoOpt showOrParseArgs)
912

913 914 915
      , option [] ["upgrade-dependencies"]
          "Pick the latest version for all dependencies, rather than trying to pick an installed version."
          installUpgradeDeps (\v flags -> flags { installUpgradeDeps = v })
916
          (yesNoOpt showOrParseArgs)
917

918 919 920
      , option [] ["only-dependencies"]
          "Install only the dependencies necessary to build the given packages"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
921
          (yesNoOpt showOrParseArgs)
922

923 924 925 926 927
      , option [] ["dependencies-only"]
          "A synonym for --only-dependencies"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
          (yesNoOpt showOrParseArgs)

928 929 930 931 932
      , option [] ["root-cmd"]
          "Command used to gain root privileges, when installing with --global."
          installRootCmd (\v flags -> flags { installRootCmd = v })
          (reqArg' "COMMAND" toFlag flagToList)

933 934 935 936 937
      , option [] ["symlink-bindir"]
          "Add symlinks to installed executables into this directory."
           installSymlinkBinDir (\v flags -> flags { installSymlinkBinDir = v })
           (reqArgFlag "DIR")

938 939 940 941 942 943
      , 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
944 945
          "Log all builds to file (name template can use $pkgid, $compiler, $os, $arch)"
          installLogFile (\v flags -> flags { installLogFile = v })
946 947
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
Duncan Coutts's avatar
Duncan Coutts committed
948

949 950
      , option [] ["remote-build-reporting"]
          "Generate build reports to send to a remote server (none, anonymous or detailed)."
951
          installBuildReports (\v flags -> flags { installBuildReports = v })
952 953 954 955
          (reqArg "LEVEL" (readP_to_E (const $ "report level must be 'none', "
                                            ++ "'anonymous' or 'detailed'")
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))
956

957 958 959
      , option [] ["one-shot"]
          "Do not record the packages in the world file."
          installOneShot (\v flags -> flags { installOneShot = v })
960
          (yesNoOpt showOrParseArgs)
961 962

      , option "j" ["jobs"]
963
        "Run NUM jobs simultaneously (or '$ncpus' if no NUM is given)."
964
        installNumJobs (\v flags -> flags { installNumJobs = v })
965
        (optArg "NUM" (fmap Flag numJobsParser)
966
                      (Flag Nothing)
967
                      (map (Just . maybe "$ncpus" show) . flagToList))
968 969
      ] ++ case showOrParseArgs of      -- TODO: remove when "cabal install"
                                        -- avoids
970
          ParseArgs ->
EyalLotem's avatar
EyalLotem committed
971
            [ option [] ["only"]
972 973
              "Only installs the package in the current directory."
              installOnly (\v flags -> flags { installOnly = v })
EyalLotem's avatar
EyalLotem committed
974
              trueArg ]
975
          _ -> []
976

977 978

instance Monoid InstallFlags where
979
  mempty = InstallFlags {
980 981 982 983 984
    installDocumentation   = mempty,
    installHaddockIndex    = mempty,
    installDryRun          = mempty,
    installReinstall       = mempty,
    installAvoidReinstalls = mempty,
985
    installOverrideReinstall = mempty,
Andres Löh's avatar
Andres Löh committed
986
    installMaxBackjumps    = mempty,
987
    installUpgradeDeps     = mempty,
Andres Löh's avatar
Andres Löh committed
988
    installReorderGoals    = mempty,
989
    installIndependentGoals= mempty,
990
    installShadowPkgs      = mempty,
991 992 993 994 995 996 997
    installOnly            = mempty,
    installOnlyDeps        = mempty,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = mempty,
    installSymlinkBinDir   = mempty,
998
    installOneShot         = mempty,
999 1000
    installNumJobs         = mempty,
    installUseSandbox      = mempty
1001
  }
1002
  mappend a b = InstallFlags {
1003 1004 1005 1006 1007
    installDocumentation   = combine installDocumentation,
    installHaddockIndex    = combine installHaddockIndex,
    installDryRun          = combine installDryRun,
    installReinstall       = combine installReinstall,
    installAvoidReinstalls = combine installAvoidReinstalls,
1008
    installOverrideReinstall = combine installOverrideReinstall,
Andres Löh's avatar
Andres Löh committed
1009
    installMaxBackjumps    = combine installMaxBackjumps,