Setup.hs 57.1 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 63
import Distribution.Simple.InstallDirs
         ( PathTemplate, toPathTemplate, fromPathTemplate )
64
import Distribution.Version
Duncan Coutts's avatar
Duncan Coutts committed
65
         ( Version(Version), anyVersion, thisVersion )
66
import Distribution.Package
67
         ( PackageIdentifier, packageName, packageVersion, Dependency(..) )
68 69
import Distribution.PackageDescription
         ( RepoKind(..) )
70
import Distribution.Text
71
         ( Text(..), display )
72
import Distribution.ReadE
73
         ( ReadE(..), readP_to_E, succeedReadE )
74
import qualified Distribution.Compat.ReadP as Parse
Andres Löh's avatar
Andres Löh committed
75
         ( ReadP, readP_to_S, readS_to_P, char, munch1, pfail, (+++) )
76 77
import Distribution.Verbosity
         ( Verbosity, normal )
78 79
import Distribution.Simple.Utils
         ( wrapText )
80

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

96 97 98 99 100 101 102 103 104
-- ------------------------------------------------------------
-- * 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,
105
    globalRemoteRepos    :: [RemoteRepo],     -- ^ Available Hackage servers.
106
    globalCacheDir       :: Flag FilePath,
107
    globalLocalRepos     :: [FilePath],
108
    globalLogsDir        :: Flag FilePath,
109
    globalWorldFile      :: Flag FilePath
110
  }
Duncan Coutts's avatar
Duncan Coutts committed
111

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

globalCommand :: CommandUI GlobalFlags
globalCommand = CommandUI {
    commandName         = "",
    commandSynopsis     = "",
128 129 130 131
    commandUsage        = \_ ->
         "This program is the command line interface "
           ++ "to the Haskell Cabal infrastructure.\n"
      ++ "See http://www.haskell.org/cabal/ for more information.\n",
132
    commandDescription  = Just $ \pname ->
133 134 135 136 137 138
         "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",
139 140
    commandDefaultFlags = defaultGlobalFlags,
    commandOptions      = \showOrParseArgs ->
141
      (case showOrParseArgs of ShowArgs -> take 3; ParseArgs -> id)
142 143 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
      [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)
171

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

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

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

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

228 229 230
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

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

248 249 250 251 252 253 254 255
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

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

defaultConfigExFlags :: ConfigExFlags
262
defaultConfigExFlags = mempty { configSolver = Flag defaultSolver }
263 264 265 266 267

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

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

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

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

ttuegel's avatar
ttuegel committed
318 319 320 321
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

322 323 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
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
404
  }
405 406 407 408 409
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

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

411
-- ------------------------------------------------------------
412
-- * Fetch command
413
-- ------------------------------------------------------------
414

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

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

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

       ] ++

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

Duncan Coutts's avatar
Duncan Coutts committed
479 480
  }

481 482 483 484
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

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

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

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

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

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

refold's avatar
refold committed
547 548
    progConf = defaultProgramConfiguration

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

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

605
-- ------------------------------------------------------------
606
-- * Get flags
607 608
-- ------------------------------------------------------------

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

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

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

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

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

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

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

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

672 673 674 675 676 677
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

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

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

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

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

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

709 710 711 712 713 714 715
        ]
  }

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

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

753 754 755 756
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

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

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

808 809 810
defaultMaxBackjumps :: Int
defaultMaxBackjumps = 200

811 812
defaultSolver :: PreSolver
defaultSolver = Choose
813 814

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

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

850 851 852 853 854 855 856 857 858 859 860 861 862
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
863 864 865 866 867
    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
868 869 870 871

installOptions ::  ShowOrParseArgs -> [OptionField InstallFlags]
installOptions showOrParseArgs =
      [ option "" ["documentation"]
872 873 874 875
          "building of documentation"
          installDocumentation (\v flags -> flags { installDocumentation = v })
          (boolOpt [] [])

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

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

888 889
      optionSolverFlags showOrParseArgs
                        installMaxBackjumps     (\v flags -> flags { installMaxBackjumps     = v })
890
                        installReorderGoals     (\v flags -> flags { installReorderGoals     = v })
891 892
                        installIndependentGoals (\v flags -> flags { installIndependentGoals = v })
                        installShadowPkgs       (\v flags -> flags { installShadowPkgs       = v }) ++
893

894
      [ option [] ["reinstall"]
895 896
          "Install even if it means installing the same version again."
          installReinstall (\v flags -> flags { installReinstall = v })
897
          (yesNoOpt showOrParseArgs)
898

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

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

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

914 915 916
      , option [] ["only-dependencies"]
          "Install only the dependencies necessary to build the given packages"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
917
          (yesNoOpt showOrParseArgs)
918

919 920 921 922 923
      , option [] ["dependencies-only"]
          "A synonym for --only-dependencies"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
          (yesNoOpt showOrParseArgs)

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

929 930 931 932 933
      , option [] ["symlink-bindir"]
          "Add symlinks to installed executables into this directory."
           installSymlinkBinDir (\v flags -> flags { installSymlinkBinDir = v })
           (reqArgFlag "DIR")

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

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

953 954 955
      , option [] ["one-shot"]
          "Do not record the packages in the world file."
          installOneShot (\v flags -> flags { installOneShot = v })
956
          (yesNoOpt showOrParseArgs)
957 958

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

973 974

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