Setup.hs 60 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
         ( AllowNewer(..), 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, numJobsParser )
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
76
         ( ReadP, readP_to_S, readS_to_P, char, munch1, pfail, sepBy1, (+++) )
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,19,1] [] = flags_latest
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,18,0] [] = flags_1_18_0
249
  | cabalLibVersion <  Version [1,19,1] [] = flags_1_19_0
250
  | otherwise = flags_latest
251
  where
252 253 254
    -- Cabal >= 1.19.1 uses --dependency and does not need --constraint
    flags_latest = flags        { configConstraints = [] }

255
    -- Cabal < 1.19.1 does not grok the --dependency flag.
256
    flags_1_19_0 = flags        { configDependencies = [] }
257
    -- Cabal < 1.18.0 doesn't know about --extra-prog-path and --sysconfdir.
258
    flags_1_18_0 = flags_1_19_0 { configProgramPathExtra = []
259 260
                                , configInstallDirs = configInstallDirs_1_18_0}
    configInstallDirs_1_18_0 = (configInstallDirs flags) { sysconfdir = NoFlag }
261
    -- Cabal < 1.14.0 doesn't know about --disable-benchmarks.
262
    flags_1_14_0 = flags_1_18_0 { configBenchmarks  = NoFlag }
263 264
    -- Cabal < 1.10.0 doesn't know about --disable-tests.
    flags_1_10_0 = flags_1_14_0 { configTests       = NoFlag }
265
    -- Cabal < 1.3.10 does not grok the --constraints flag.
266
    flags_1_3_10 = flags_1_10_0 { configConstraints = [] }
267

268 269 270 271 272 273 274 275
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
276
    configExConstraints:: [UserConstraint],
277
    configPreferences  :: [Dependency],
278 279
    configSolver       :: Flag PreSolver,
    configAllowNewer   :: Flag AllowNewer
280 281 282
  }

defaultConfigExFlags :: ConfigExFlags
283
defaultConfigExFlags = mempty { configSolver = Flag defaultSolver }
284 285 286 287 288

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

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
316 317 318 319
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
320 321

  , optionSolver configSolver (\v flags -> flags { configSolver = v })
322 323 324 325 326 327 328 329

  , option [] ["allow-newer"]
    "Ignore upper bounds in dependencies on some or all packages."
    configAllowNewer (\v flags -> flags { configAllowNewer = v})
    (optArg "PKGS"
     (fmap Flag allowNewerParser) (Flag AllowNewerAll)
     allowNewerPrinter)

330 331 332 333 334
  ]

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
335
    configExConstraints= mempty,
336
    configPreferences  = mempty,
337 338
    configSolver       = mempty,
    configAllowNewer   = mempty
339 340 341
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
342
    configExConstraints= combine configExConstraints,
343
    configPreferences  = combine configPreferences,
344 345
    configSolver       = combine configSolver,
    configAllowNewer   = combine configAllowNewer
346 347 348
  }
    where combine field = field a `mappend` field b

ttuegel's avatar
ttuegel committed
349 350 351 352
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

353 354 355 356 357 358 359 360 361 362
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
}

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
363
  option [] ["only"]
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
  "Don't reinstall add-source dependencies (sandbox-only)"
  buildOnly (\v flags -> flags { buildOnly = v })
  (noArg (Flag SkipAddSourceDepsCheck))

  : []

buildCommand :: CommandUI (BuildFlags, BuildExFlags)
buildCommand = parent {
    commandDefaultFlags = (commandDefaultFlags parent, mempty),
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
                          (commandOptions parent showOrParseArgs)
                          ++
                          liftOptions snd setSnd (buildExOptions showOrParseArgs)
  }
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

    parent = Cabal.buildCommand defaultProgramConfiguration

instance Monoid BuildExFlags where
  mempty = BuildExFlags {
    buildOnly    = mempty
  }
  mappend a b = BuildExFlags {
    buildOnly    = combine buildOnly
  }
    where combine field = field a `mappend` field b

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

398
testCommand :: CommandUI (TestFlags, BuildFlags, BuildExFlags)
399
testCommand = parent {
400 401
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
402
  commandOptions      =
403
    \showOrParseArgs -> liftOptions get1 set1
404 405
                        (commandOptions parent showOrParseArgs)
                        ++
406 407 408 409
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
410 411
  }
  where
412 413 414
    get1 (a,_,_) = a; set1 a (_,b,c) = (a,b,c)
    get2 (_,b,_) = b; set2 b (a,_,c) = (a,b,c)
    get3 (_,_,c) = c; set3 c (a,b,_) = (a,b,c)
415

416 417
    parent   = Cabal.testCommand
    progConf = defaultProgramConfiguration
418 419 420 421 422

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

423
benchmarkCommand :: CommandUI (BenchmarkFlags, BuildFlags, BuildExFlags)
424
benchmarkCommand = parent {
425 426
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
427
  commandOptions      =
428
    \showOrParseArgs -> liftOptions get1 set1
429 430
                        (commandOptions parent showOrParseArgs)
                        ++
431 432 433 434
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
ttuegel's avatar
ttuegel committed
435
  }
436
  where
437 438 439
    get1 (a,_,_) = a; set1 a (_,b,c) = (a,b,c)
    get2 (_,b,_) = b; set2 b (a,_,c) = (a,b,c)
    get3 (_,_,c) = c; set3 c (a,b,_) = (a,b,c)
440

441 442
    parent   = Cabal.benchmarkCommand
    progConf = defaultProgramConfiguration
ttuegel's avatar
ttuegel committed
443

444
-- ------------------------------------------------------------
445
-- * Fetch command
446
-- ------------------------------------------------------------
447

448 449 450 451
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
452
      fetchSolver           :: Flag PreSolver,
453 454 455
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
456
      fetchShadowPkgs       :: Flag Bool,
457 458 459 460 461 462 463 464
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
465 466 467 468
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
    fetchReorderGoals     = Flag False,
    fetchIndependentGoals = Flag False,
469
    fetchShadowPkgs       = Flag False,
470 471 472 473
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
474 475
fetchCommand = CommandUI {
    commandName         = "fetch",
476
    commandSynopsis     = "Downloads packages for later installation.",
Duncan Coutts's avatar
Duncan Coutts committed
477
    commandDescription  = Nothing,
refold's avatar
refold committed
478
    commandUsage        = usagePackages "fetch",
479
    commandDefaultFlags = defaultFetchFlags,
480
    commandOptions      = \ showOrParseArgs -> [
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
         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
502 503 504 505

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
506 507
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
508 509
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
510
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
511

Duncan Coutts's avatar
Duncan Coutts committed
512 513
  }

514 515 516 517
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

518
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
519 520
updateCommand = CommandUI {
    commandName         = "update",
521
    commandSynopsis     = "Updates list of known packages.",
Duncan Coutts's avatar
Duncan Coutts committed
522
    commandDescription  = Nothing,
refold's avatar
refold committed
523
    commandUsage        = usageFlags "update",
524
    commandDefaultFlags = toFlag normal,
525
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
526 527
  }

528
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
529
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
530
    commandName         = "upgrade",
531
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
532
    commandDescription  = Nothing,
refold's avatar
refold committed
533
    commandUsage        = usageFlagsOrPackages "upgrade",
534
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
535
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
536 537
  }

Duncan Coutts's avatar
Duncan Coutts committed
538 539 540 541 542 543 544 545 546 547 548
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

549 550 551
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
552
    commandSynopsis     = "Check the package for common mistakes.",
553 554
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
555
    commandDefaultFlags = toFlag normal,
556
    commandOptions      = \_ -> []
557 558
  }

559
runCommand :: CommandUI (BuildFlags, BuildExFlags)
refold's avatar
refold committed
560 561 562 563 564
runCommand = CommandUI {
    commandName         = "run",
    commandSynopsis     = "Runs the compiled executable.",
    commandDescription  = Nothing,
    commandUsage        =
565 566 567
      \pname -> "Usage: " ++ pname
                ++ " run [FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]\n\n"
                ++ "Flags for run:",
refold's avatar
refold committed
568
    commandDefaultFlags = mempty,
569 570 571 572 573 574
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
                          (Cabal.buildOptions progConf showOrParseArgs)
                          ++
                          liftOptions snd setSnd
                          (buildExOptions showOrParseArgs)
refold's avatar
refold committed
575 576
  }
  where
577 578 579
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

refold's avatar
refold committed
580 581
    progConf = defaultProgramConfiguration

582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
-- ------------------------------------------------------------
-- * 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
600 601 602
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
    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))
      ]
623 624
  }

625 626 627 628 629 630 631 632 633 634 635 636 637
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

638
-- ------------------------------------------------------------
639
-- * Get flags
640 641
-- ------------------------------------------------------------

642 643 644 645 646 647
data GetFlags = GetFlags {
    getDestDir          :: Flag FilePath,
    getPristine         :: Flag Bool,
    getSourceRepository :: Flag (Maybe RepoKind),
    getVerbosity        :: Flag Verbosity
  }
648

649 650 651 652 653 654
defaultGetFlags :: GetFlags
defaultGetFlags = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = toFlag normal
655 656
   }

657 658 659 660
getCommand :: CommandUI GetFlags
getCommand = CommandUI {
    commandName         = "get",
    commandSynopsis     = "Gets a package's source code.",
661 662 663 664 665
    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",
666
    commandUsage        = usagePackages "get",
667 668
    commandDefaultFlags = mempty,
    commandOptions      = \_ -> [
669
        optionVerbosity getVerbosity (\v flags -> flags { getVerbosity = v })
670 671

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

676
       ,option "s" ["source-repository"]
677
         "Copy the package's source repository (ie git clone, darcs get, etc as appropriate)."
678 679 680 681 682 683
         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))

684 685 686
       , option [] ["pristine"]
           ("Unpack the original pristine tarball, rather than updating the "
           ++ ".cabal file with the latest revision from the package archive.")
687
           getPristine (\v flags -> flags { getPristine = v })
688
           trueArg
689 690 691
       ]
  }

692 693 694 695 696 697 698
-- 'cabal unpack' is a deprecated alias for 'cabal get'.
unpackCommand :: CommandUI GetFlags
unpackCommand = getCommand {
  commandName  = "unpack",
  commandUsage = usagePackages "unpack"
  }

699 700 701 702 703 704 705
instance Monoid GetFlags where
  mempty = defaultGetFlags
  mappend a b = GetFlags {
    getDestDir          = combine getDestDir,
    getPristine         = combine getPristine,
    getSourceRepository = combine getSourceRepository,
    getVerbosity        = combine getVerbosity
706 707 708
  }
    where combine field = field a `mappend` field b

709 710 711 712 713 714
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
    listInstalled :: Flag Bool,
715
    listSimpleOutput :: Flag Bool,
716 717 718 719 720 721
    listVerbosity :: Flag Verbosity
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
    listInstalled = Flag False,
722
    listSimpleOutput = Flag False,
723 724 725 726 727 728
    listVerbosity = toFlag normal
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
729
    commandSynopsis     = "List packages matching a search string.",
730
    commandDescription  = Nothing,
refold's avatar
refold committed
731
    commandUsage        = usageFlagsOrPackages "list",
732
    commandDefaultFlags = defaultListFlags,
733
    commandOptions      = \_ -> [
734
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
735

736
        , option [] ["installed"]
737 738 739 740
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

741 742 743 744 745
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

746 747 748 749 750 751 752
        ]
  }

instance Monoid ListFlags where
  mempty = defaultListFlags
  mappend a b = ListFlags {
    listInstalled = combine listInstalled,
753
    listSimpleOutput = combine listSimpleOutput,
754 755 756 757
    listVerbosity = combine listVerbosity
  }
    where combine field = field a `mappend` field b

758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
-- ------------------------------------------------------------
-- * 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
776
    commandUsage        = usagePackages "info",
777 778 779 780 781 782 783 784 785 786 787 788 789
    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

790 791 792 793
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

794 795
-- | Install takes the same flags as configure along with a few extras.
--
796
data InstallFlags = InstallFlags {
797 798 799
    installDocumentation    :: Flag Bool,
    installHaddockIndex     :: Flag PathTemplate,
    installDryRun           :: Flag Bool,
800 801 802
    installMaxBackjumps     :: Flag Int,
    installReorderGoals     :: Flag Bool,
    installIndependentGoals :: Flag Bool,
803
    installShadowPkgs       :: Flag Bool,
804 805
    installReinstall        :: Flag Bool,
    installAvoidReinstalls  :: Flag Bool,
806
    installOverrideReinstall :: Flag Bool,
807 808 809 810 811 812 813 814
    installUpgradeDeps      :: Flag Bool,
    installOnly             :: Flag Bool,
    installOnlyDeps         :: Flag Bool,
    installRootCmd          :: Flag String,
    installSummaryFile      :: [PathTemplate],
    installLogFile          :: Flag PathTemplate,
    installBuildReports     :: Flag ReportLevel,
    installSymlinkBinDir    :: Flag FilePath,
815
    installOneShot          :: Flag Bool,
816 817
    installNumJobs          :: Flag (Maybe Int),
    installAllowNewer       :: Flag AllowNewer
818 819 820 821
  }

defaultInstallFlags :: InstallFlags
defaultInstallFlags = InstallFlags {
822 823 824
    installDocumentation   = Flag False,
    installHaddockIndex    = Flag docIndexFile,
    installDryRun          = Flag False,
825 826 827
    installMaxBackjumps    = Flag defaultMaxBackjumps,
    installReorderGoals    = Flag False,
    installIndependentGoals= Flag False,
828
    installShadowPkgs      = Flag False,
829 830
    installReinstall       = Flag False,
    installAvoidReinstalls = Flag False,
831
    installOverrideReinstall = Flag False,
832 833 834 835 836 837 838 839
    installUpgradeDeps     = Flag False,
    installOnly            = Flag False,
    installOnlyDeps        = Flag False,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = Flag NoReports,
    installSymlinkBinDir   = mempty,
840
    installOneShot         = Flag False,
841 842
    installNumJobs         = mempty,
    installAllowNewer      = Flag AllowNewerNone
843
  }
844 845
  where
    docIndexFile = toPathTemplate ("$datadir" </> "doc" </> "index.html")
846

847 848 849 850 851 852 853 854 855 856 857 858 859
allowNewerParser :: ReadE AllowNewer
allowNewerParser = ReadE $ \s ->
  case s of
    ""      -> Right AllowNewerNone
    "False" -> Right AllowNewerNone
    "True"  -> Right AllowNewerAll
    _       ->
      case readPToMaybe pkgsParser s of
        Just pkgs -> Right . AllowNewerSome $ pkgs
        Nothing   -> Left ("Cannot parse the list of packages: " ++ s)
  where
    pkgsParser = Parse.sepBy1 parse (Parse.char ',')

860 861 862 863 864 865 866 867
allowNewerPrinter :: Flag AllowNewer -> [Maybe String]
allowNewerPrinter (Flag AllowNewerNone)        = [Just "False"]
allowNewerPrinter (Flag AllowNewerAll)         = [Just "True"]
allowNewerPrinter (Flag (AllowNewerSome pkgs)) =
  [Just . intercalate "," . map display $ pkgs]
allowNewerPrinter NoFlag                       = []


868 869 870
defaultMaxBackjumps :: Int
defaultMaxBackjumps = 200

871 872
defaultSolver :: PreSolver
defaultSolver = Choose
873 874

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

877
installCommand :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
878
installCommand = CommandUI {
879 880
  commandName         = "install",
  commandSynopsis     = "Installs a list of packages.",
refold's avatar
refold committed
881
  commandUsage        = usageFlagsOrPackages "install",
882 883 884 885 886
  commandDescription  = Just $ \pname ->
    let original = case commandDescription configureCommand of
          Just desc -> desc pname ++ "\n"
          Nothing   -> ""
     in original
887
     ++ "Examples:\n"
888 889 890 891 892 893 894 895
     ++ "  " ++ 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",
896
  commandDefaultFlags = (mempty, mempty, mempty, mempty),
897
  commandOptions      = \showOrParseArgs ->
898 899
       liftOptions get1 set1
       (filter ((`notElem` ["constraint", "dependency"]) . optionName) $
900
                              configureOptions   showOrParseArgs)
901 902 903
    ++ liftOptions get2 set2
       (filter ((/=) "allow-newer" . optionName)
               $ configureExOptions showOrParseArgs)
904
    ++ liftOptions get3 set3 (installOptions     showOrParseArgs)
905
    ++ liftOptions get4 set4 (haddockOptions     showOrParseArgs)
906
  }
907
  where
908 909 910 911 912
    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)

913 914 915 916 917 918 919 920 921 922 923 924 925
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
926 927 928 929 930
    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
931 932 933 934

installOptions ::  ShowOrParseArgs -> [OptionField InstallFlags]
installOptions showOrParseArgs =
      [ option "" ["documentation"]
935 936 937 938
          "building of documentation"
          installDocumentation (\v flags -> flags { installDocumentation = v })
          (boolOpt [] [])

939 940
      , option [] ["doc-index-file"]
          "A central index of haddock API documentation (template cannot use $pkgid)"
941 942 943
          installHaddockIndex (\v flags -> flags { installHaddockIndex = v })
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
944

945
      , option [] ["dry-run"]
946 947 948
          "Do not install anything, only print what would be installed."
          installDryRun (\v flags -> flags { installDryRun = v })
          trueArg
949
      ] ++
950

951 952
      optionSolverFlags showOrParseArgs
                        installMaxBackjumps     (\v flags -> flags { installMaxBackjumps     = v })
953
                        installReorderGoals     (\v flags -> flags { installReorderGoals     = v })
954 955
                        installIndependentGoals (\v flags -> flags { installIndependentGoals = v })
                        installShadowPkgs       (\v flags -> flags { installShadowPkgs       = v }) ++
956

957
      [ option [] ["reinstall"]
958 959
          "Install even if it means installing the same version again."
          installReinstall (\v flags -> flags { installReinstall = v })
960
          (yesNoOpt showOrParseArgs)
961

962 963 964
      , option [] ["avoid-reinstalls"]
          "Do not select versions that would destructively overwrite installed packages."
          installAvoidReinstalls (\v flags -> flags { installAvoidReinstalls = v })
965
          (yesNoOpt showOrParseArgs)
966

967
      , option [] ["force-reinstalls"]
968
          "Reinstall packages even if they will most likely break other installed packages."
969
          installOverrideReinstall (\v flags -> flags { installOverrideReinstall = v })
970
          (yesNoOpt showOrParseArgs)
971

972 973 974 975 976
      , option [] ["allow-newer"]
          "Ignore upper bounds in dependencies on some or all packages."
          installAllowNewer (\v flags -> flags { installAllowNewer = v})
          (optArg "PKGS"
             (fmap Flag allowNewerParser) (Flag AllowNewerAll)
977
             allowNewerPrinter)
978

979 980 981
      , option [] ["upgrade-dependencies"]
          "Pick the latest version for all dependencies, rather than trying to pick an installed version."
          installUpgradeDeps (\v flags -> flags { installUpgradeDeps = v })
982
          (yesNoOpt showOrParseArgs)
983

984 985 986
      , option [] ["only-dependencies"]
          "Install only the dependencies necessary to build the given packages"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
987
          (yesNoOpt showOrParseArgs)