Setup.hs 55.5 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
ttuegel's avatar
ttuegel committed
18
    , buildCommand, BuildFlags(..)
19
    , installCommand, InstallFlags(..), installOptions, defaultInstallFlags
20
    , listCommand, ListFlags(..)
Duncan Coutts's avatar
Duncan Coutts committed
21
    , updateCommand
ijones's avatar
ijones committed
22
    , upgradeCommand
23
    , infoCommand, InfoFlags(..)
24
    , fetchCommand, FetchFlags(..)
25
    , checkCommand
26
    , uploadCommand, UploadFlags(..)
27
    , reportCommand, ReportFlags(..)
28
    , unpackCommand, UnpackFlags(..)
29
    , initCommand, IT.InitFlags(..)
30
    , sdistCommand, SDistFlags(..), SDistExFlags(..), ArchiveFormat(..)
31
    , win32SelfUpgradeCommand, Win32SelfUpgradeFlags(..)
32
    , indexCommand, IndexFlags(..)
33 34 35
    , dumpPkgEnvCommand, sandboxConfigureCommand, sandboxAddSourceCommand
    , sandboxBuildCommand, sandboxInstallCommand, defaultSandboxLocation
    , SandboxFlags(..)
Duncan Coutts's avatar
Duncan Coutts committed
36 37

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

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

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

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

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

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

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

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

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

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

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

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

232
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
233 234 235
filterConfigureFlags flags cabalLibVersion
  | cabalLibVersion >= Version [1,3,10] [] = flags
    -- older Cabal does not grok the constraints flag:
236
  | otherwise = flags { configConstraints = [] }
237

238 239 240 241 242 243 244 245
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
246
    configExConstraints:: [UserConstraint],
247
    configPreferences  :: [Dependency],
248
    configSolver       :: Flag PreSolver
249 250 251
  }

defaultConfigExFlags :: ConfigExFlags
252
defaultConfigExFlags = mempty { configSolver = Flag defaultSolver }
253 254 255 256 257

configureExCommand :: CommandUI (ConfigFlags, ConfigExFlags)
configureExCommand = configureCommand {
    commandDefaultFlags = (mempty, defaultConfigExFlags),
    commandOptions      = \showOrParseArgs ->
258 259
         liftOptions fst setFst (filter ((/="constraint") . optionName) $
                                 configureOptions   showOrParseArgs)
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
      ++ 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))
275 276 277 278 279 280
  , 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))
281 282 283 284

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
285 286 287 288
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
289 290

  , optionSolver configSolver (\v flags -> flags { configSolver = v })
291 292 293 294 295
  ]

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
296
    configExConstraints= mempty,
297 298
    configPreferences  = mempty,
    configSolver       = mempty
299 300 301
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
302
    configExConstraints= combine configExConstraints,
303 304
    configPreferences  = combine configPreferences,
    configSolver       = combine configSolver
305 306 307
  }
    where combine field = field a `mappend` field b

ttuegel's avatar
ttuegel committed
308 309 310 311 312 313 314 315 316
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

buildCommand :: CommandUI BuildFlags
buildCommand = (Cabal.buildCommand defaultProgramConfiguration) {
    commandDefaultFlags = mempty
  }

317
-- ------------------------------------------------------------
318
-- * Fetch command
319
-- ------------------------------------------------------------
320

321 322 323 324
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
325
      fetchSolver           :: Flag PreSolver,
326 327 328
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
329
      fetchShadowPkgs       :: Flag Bool,
330 331 332 333 334 335 336 337
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
338 339 340 341
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
    fetchReorderGoals     = Flag False,
    fetchIndependentGoals = Flag False,
342
    fetchShadowPkgs       = Flag False,
343 344 345 346
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
347 348
fetchCommand = CommandUI {
    commandName         = "fetch",
349
    commandSynopsis     = "Downloads packages for later installation.",
Duncan Coutts's avatar
Duncan Coutts committed
350 351
    commandDescription  = Nothing,
    commandUsage        = usagePackages "fetch",
352
    commandDefaultFlags = defaultFetchFlags,
353
    commandOptions      = \ showOrParseArgs -> [
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
         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
375 376 377 378

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
379 380
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
381 382
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
383
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
384

Duncan Coutts's avatar
Duncan Coutts committed
385 386
  }

387 388 389 390
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

391
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
392 393 394 395 396
updateCommand = CommandUI {
    commandName         = "update",
    commandSynopsis     = "Updates list of known packages",
    commandDescription  = Nothing,
    commandUsage        = usagePackages "update",
397
    commandDefaultFlags = toFlag normal,
398
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
399 400
  }

401
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
402
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
403
    commandName         = "upgrade",
404
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
405
    commandDescription  = Nothing,
406
    commandUsage        = usagePackages "upgrade",
407
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
408
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
409 410
  }

Duncan Coutts's avatar
Duncan Coutts committed
411 412 413 414 415 416 417 418 419 420 421
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

422 423 424 425 426 427
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
    commandSynopsis     = "Check the package for common mistakes",
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
428
    commandDefaultFlags = toFlag normal,
429
    commandOptions      = \_ -> []
430 431
  }

432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
-- ------------------------------------------------------------
-- * 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
450 451 452
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
    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))
      ]
473 474
  }

475 476 477 478 479 480 481 482 483 484 485 486 487
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

488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
-- ------------------------------------------------------------
-- * Unpack flags
-- ------------------------------------------------------------

data UnpackFlags = UnpackFlags {
      unpackDestDir :: Flag FilePath,
      unpackVerbosity :: Flag Verbosity
    }

defaultUnpackFlags :: UnpackFlags
defaultUnpackFlags = UnpackFlags {
    unpackDestDir = mempty,
    unpackVerbosity = toFlag normal
   }

unpackCommand :: CommandUI UnpackFlags
unpackCommand = CommandUI {
    commandName         = "unpack",
    commandSynopsis     = "Unpacks packages for user inspection.",
    commandDescription  = Nothing,
    commandUsage        = usagePackages "unpack",
    commandDefaultFlags = mempty,
    commandOptions      = \_ -> [
        optionVerbosity unpackVerbosity (\v flags -> flags { unpackVerbosity = v })

       ,option "d" ["destdir"]
         "where to unpack the packages, defaults to the current directory."
         unpackDestDir (\v flags -> flags { unpackDestDir = v })
         (reqArgFlag "PATH")
       ]
  }

instance Monoid UnpackFlags where
  mempty = defaultUnpackFlags
  mappend a b = UnpackFlags {
     unpackDestDir = combine unpackDestDir
    ,unpackVerbosity = combine unpackVerbosity
  }
    where combine field = field a `mappend` field b

528 529 530 531 532 533
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
    listInstalled :: Flag Bool,
534
    listSimpleOutput :: Flag Bool,
535 536 537 538 539 540
    listVerbosity :: Flag Verbosity
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
    listInstalled = Flag False,
541
    listSimpleOutput = Flag False,
542 543 544 545 546 547
    listVerbosity = toFlag normal
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
548
    commandSynopsis     = "List packages matching a search string.",
549 550
    commandDescription  = Nothing,
    commandUsage        = usagePackages "list",
551
    commandDefaultFlags = defaultListFlags,
552
    commandOptions      = \_ -> [
553
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
554

555
        , option [] ["installed"]
556 557 558 559
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

560 561 562 563 564
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

565 566 567 568 569 570 571
        ]
  }

instance Monoid ListFlags where
  mempty = defaultListFlags
  mappend a b = ListFlags {
    listInstalled = combine listInstalled,
572
    listSimpleOutput = combine listSimpleOutput,
573 574 575 576
    listVerbosity = combine listVerbosity
  }
    where combine field = field a `mappend` field b

577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
-- ------------------------------------------------------------
-- * 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,
    commandUsage        = usagePackages "info",
    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

609 610 611 612
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

613 614
-- | Install takes the same flags as configure along with a few extras.
--
615
data InstallFlags = InstallFlags {
616 617 618
    installDocumentation    :: Flag Bool,
    installHaddockIndex     :: Flag PathTemplate,
    installDryRun           :: Flag Bool,
619 620 621
    installMaxBackjumps     :: Flag Int,
    installReorderGoals     :: Flag Bool,
    installIndependentGoals :: Flag Bool,
622
    installShadowPkgs       :: Flag Bool,
623 624
    installReinstall        :: Flag Bool,
    installAvoidReinstalls  :: Flag Bool,
625
    installOverrideReinstall :: Flag Bool,
626 627 628 629 630 631 632 633
    installUpgradeDeps      :: Flag Bool,
    installOnly             :: Flag Bool,
    installOnlyDeps         :: Flag Bool,
    installRootCmd          :: Flag String,
    installSummaryFile      :: [PathTemplate],
    installLogFile          :: Flag PathTemplate,
    installBuildReports     :: Flag ReportLevel,
    installSymlinkBinDir    :: Flag FilePath,
634
    installOneShot          :: Flag Bool,
635
    installNumJobs          :: Flag (Maybe Int)
636 637 638 639
  }

defaultInstallFlags :: InstallFlags
defaultInstallFlags = InstallFlags {
640 641 642
    installDocumentation   = Flag False,
    installHaddockIndex    = Flag docIndexFile,
    installDryRun          = Flag False,
643 644 645
    installMaxBackjumps    = Flag defaultMaxBackjumps,
    installReorderGoals    = Flag False,
    installIndependentGoals= Flag False,
646
    installShadowPkgs      = Flag False,
647 648
    installReinstall       = Flag False,
    installAvoidReinstalls = Flag False,
649
    installOverrideReinstall = Flag False,
650 651 652 653 654 655 656 657
    installUpgradeDeps     = Flag False,
    installOnly            = Flag False,
    installOnlyDeps        = Flag False,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = Flag NoReports,
    installSymlinkBinDir   = mempty,
658
    installOneShot         = Flag False,
659
    installNumJobs         = mempty
660
  }
661 662
  where
    docIndexFile = toPathTemplate ("$datadir" </> "doc" </> "index.html")
663

664 665 666
defaultMaxBackjumps :: Int
defaultMaxBackjumps = 200

667 668
defaultSolver :: PreSolver
defaultSolver = Choose
669 670

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

673
installCommand :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
674
installCommand = CommandUI {
675 676 677
  commandName         = "install",
  commandSynopsis     = "Installs a list of packages.",
  commandUsage        = usagePackages "install",
678 679 680 681 682
  commandDescription  = Just $ \pname ->
    let original = case commandDescription configureCommand of
          Just desc -> desc pname ++ "\n"
          Nothing   -> ""
     in original
683
     ++ "Examples:\n"
684 685 686 687 688 689 690 691
     ++ "  " ++ 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",
692
  commandDefaultFlags = (mempty, mempty, mempty, mempty),
693
  commandOptions      = \showOrParseArgs ->
694 695
       liftOptions get1 set1 (filter ((/="constraint") . optionName) $
                              configureOptions   showOrParseArgs)
696 697
    ++ liftOptions get2 set2 (configureExOptions showOrParseArgs)
    ++ liftOptions get3 set3 (installOptions     showOrParseArgs)
698
    ++ liftOptions get4 set4 (haddockOptions     showOrParseArgs)
699
  }
700
  where
701 702 703 704 705
    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)

706 707 708 709 710 711 712 713 714 715 716 717 718
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
719 720 721 722 723
    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
724 725 726 727

installOptions ::  ShowOrParseArgs -> [OptionField InstallFlags]
installOptions showOrParseArgs =
      [ option "" ["documentation"]
728 729 730 731
          "building of documentation"
          installDocumentation (\v flags -> flags { installDocumentation = v })
          (boolOpt [] [])

732 733
      , option [] ["doc-index-file"]
          "A central index of haddock API documentation (template cannot use $pkgid)"
734 735 736
          installHaddockIndex (\v flags -> flags { installHaddockIndex = v })
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
737

738
      , option [] ["dry-run"]
739 740 741
          "Do not install anything, only print what would be installed."
          installDryRun (\v flags -> flags { installDryRun = v })
          trueArg
742
      ] ++
743

744 745
      optionSolverFlags showOrParseArgs
                        installMaxBackjumps     (\v flags -> flags { installMaxBackjumps     = v })
746
                        installReorderGoals     (\v flags -> flags { installReorderGoals     = v })
747 748
                        installIndependentGoals (\v flags -> flags { installIndependentGoals = v })
                        installShadowPkgs       (\v flags -> flags { installShadowPkgs       = v }) ++
749

750
      [ option [] ["reinstall"]
751 752
          "Install even if it means installing the same version again."
          installReinstall (\v flags -> flags { installReinstall = v })
753
          (yesNoOpt showOrParseArgs)
754

755 756 757
      , option [] ["avoid-reinstalls"]
          "Do not select versions that would destructively overwrite installed packages."
          installAvoidReinstalls (\v flags -> flags { installAvoidReinstalls = v })
758
          (yesNoOpt showOrParseArgs)
759

760
      , option [] ["force-reinstalls"]
761
          "Reinstall packages even if they will most likely break other installed packages."
762
          installOverrideReinstall (\v flags -> flags { installOverrideReinstall = v })
763
          (yesNoOpt showOrParseArgs)
764

765 766 767
      , option [] ["upgrade-dependencies"]
          "Pick the latest version for all dependencies, rather than trying to pick an installed version."
          installUpgradeDeps (\v flags -> flags { installUpgradeDeps = v })
768
          (yesNoOpt showOrParseArgs)
769

770 771 772
      , option [] ["only-dependencies"]
          "Install only the dependencies necessary to build the given packages"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
773
          (yesNoOpt showOrParseArgs)
774

775 776 777 778 779
      , option [] ["root-cmd"]
          "Command used to gain root privileges, when installing with --global."
          installRootCmd (\v flags -> flags { installRootCmd = v })
          (reqArg' "COMMAND" toFlag flagToList)

780 781 782 783 784
      , option [] ["symlink-bindir"]
          "Add symlinks to installed executables into this directory."
           installSymlinkBinDir (\v flags -> flags { installSymlinkBinDir = v })
           (reqArgFlag "DIR")

785 786 787 788 789 790
      , 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
791 792
          "Log all builds to file (name template can use $pkgid, $compiler, $os, $arch)"
          installLogFile (\v flags -> flags { installLogFile = v })
793 794
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
Duncan Coutts's avatar
Duncan Coutts committed
795

796 797
      , option [] ["remote-build-reporting"]
          "Generate build reports to send to a remote server (none, anonymous or detailed)."
798
          installBuildReports (\v flags -> flags { installBuildReports = v })
799 800 801 802
          (reqArg "LEVEL" (readP_to_E (const $ "report level must be 'none', "
                                            ++ "'anonymous' or 'detailed'")
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))
803

804 805 806
      , option [] ["one-shot"]
          "Do not record the packages in the world file."
          installOneShot (\v flags -> flags { installOneShot = v })
807
          (yesNoOpt showOrParseArgs)
808 809

      , option "j" ["jobs"]
810
        "Run NUM jobs simultaneously."
811
        installNumJobs (\v flags -> flags { installNumJobs = v })
812 813 814 815 816
        (optArg "NUM" (readP_to_E (\_ -> "jobs should be a number")
                                  (fmap (toFlag . Just)
                                        (Parse.readS_to_P reads)))
                      (Flag Nothing)
                      (map (fmap show) . flagToList))
817 818 819 820 821 822 823
      ] ++ case showOrParseArgs of      -- TODO: remove when "cabal install" avoids
          ParseArgs ->
            option [] ["only"]
              "Only installs the package in the current directory."
              installOnly (\v flags -> flags { installOnly = v })
              trueArg
             : []
824
          _ -> []
825 826

instance Monoid InstallFlags where
827
  mempty = InstallFlags {
828 829 830 831 832
    installDocumentation   = mempty,
    installHaddockIndex    = mempty,
    installDryRun          = mempty,
    installReinstall       = mempty,
    installAvoidReinstalls = mempty,
833
    installOverrideReinstall = mempty,
Andres Löh's avatar
Andres Löh committed
834
    installMaxBackjumps    = mempty,
835
    installUpgradeDeps     = mempty,
Andres Löh's avatar
Andres Löh committed
836
    installReorderGoals    = mempty,
837
    installIndependentGoals= mempty,
838
    installShadowPkgs      = mempty,
839 840 841 842 843 844 845
    installOnly            = mempty,
    installOnlyDeps        = mempty,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = mempty,
    installSymlinkBinDir   = mempty,
846 847
    installOneShot         = mempty,
    installNumJobs         = mempty
848
  }
849
  mappend a b = InstallFlags {
850 851 852 853 854
    installDocumentation   = combine installDocumentation,
    installHaddockIndex    = combine installHaddockIndex,
    installDryRun          = combine installDryRun,
    installReinstall       = combine installReinstall,
    installAvoidReinstalls = combine installAvoidReinstalls,
855
    installOverrideReinstall = combine installOverrideReinstall,
Andres Löh's avatar
Andres Löh committed
856
    installMaxBackjumps    = combine installMaxBackjumps,
857
    installUpgradeDeps     = combine installUpgradeDeps,
Andres Löh's avatar
Andres Löh committed
858
    installReorderGoals    = combine installReorderGoals,
859
    installIndependentGoals= combine installIndependentGoals,
860
    installShadowPkgs      = combine installShadowPkgs,
861 862 863 864 865 866 867
    installOnly            = combine installOnly,
    installOnlyDeps        = combine installOnlyDeps,
    installRootCmd         = combine installRootCmd,
    installSummaryFile     = combine installSummaryFile,
    installLogFile         = combine installLogFile,
    installBuildReports    = combine installBuildReports,
    installSymlinkBinDir   = combine installSymlinkBinDir,
868 869
    installOneShot         = combine installOneShot,
    installNumJobs         = combine installNumJobs
870 871 872
  }
    where combine field = field a `mappend` field b

873 874 875 876 877 878 879 880 881
-- ------------------------------------------------------------
-- * Upload flags
-- ------------------------------------------------------------

data UploadFlags = UploadFlags {
    uploadCheck     :: Flag Bool,
    uploadUsername  :: Flag Username,
    uploadPassword  :: Flag Password,
    uploadVerbosity :: Flag Verbosity
882
  }
883 884 885 886 887 888 889 890 891 892 893 894 895 896

defaultUploadFlags :: UploadFlags
defaultUploadFlags = UploadFlags {
    uploadCheck     = toFlag False,
    uploadUsername  = mempty,
    uploadPassword  = mempty,
    uploadVerbosity = toFlag normal
  }

uploadCommand :: CommandUI UploadFlags
uploadCommand = CommandUI {
    commandName         = "upload",
    commandSynopsis     = "Uploads source packages to Hackage",
    commandDescription  = Just $ \_ ->
897
         "You can store your Hackage login in the ~/.cabal/config file\n",
898 899 900 901 902
    commandUsage        = \pname ->
         "Usage: " ++ pname ++ " upload [FLAGS] [TARFILES]\n\n"
      ++ "Flags for upload:",
    commandDefaultFlags = defaultUploadFlags,
    commandOptions      = \_ ->
903
      [optionVerbosity uploadVerbosity (\v flags -> flags { uploadVerbosity = v })
904 905 906 907

      ,option ['c'] ["check"]
         "Do not upload, just do QA checks."
        uploadCheck (\v flags -> flags { uploadCheck = v })
908
        trueArg
909 910 911 912

      ,option ['u'] ["username"]
        "Hackage username."
        uploadUsername (\v flags -> flags { uploadUsername = v })
913 914
        (reqArg' "USERNAME" (toFlag . Username)
                            (flagToList . fmap unUsername))
915 916 917 918

      ,option ['p'] ["password"]
        "Hackage password."
        uploadPassword (\v flags -> flags { uploadPassword = v })
919 920
        (reqArg' "PASSWORD" (toFlag . Password)
                            (flagToList . fmap unPassword))
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938
      ]
  }

instance Monoid UploadFlags where
  mempty = UploadFlags {
    uploadCheck     = mempty,
    uploadUsername  = mempty,
    uploadPassword  = mempty,
    uploadVerbosity = mempty
  }
  mappend a b = UploadFlags {
    uploadCheck     = combine uploadCheck,
    uploadUsername  = combine uploadUsername,
    uploadPassword  = combine uploadPassword,
    uploadVerbosity = combine uploadVerbosity
  }
    where combine field = field a `mappend` field b

939 940 941 942 943 944 945 946
-- ------------------------------------------------------------
-- * Init flags
-- ------------------------------------------------------------

emptyInitFlags :: IT.InitFlags
emptyInitFlags  = mempty

defaultInitFlags :: IT.InitFlags
947
defaultInitFlags  = emptyInitFlags { IT.initVerbosity = toFlag normal }
948 949 950 951 952

initCommand :: CommandUI IT.InitFlags
initCommand = CommandUI {
    commandName = "init",
    commandSynopsis = "Interactively create a .cabal file.",
953 954 955 956 957 958 959 960 961 962 963 964
    commandDescription = Just $ \_ -> wrapText $
         "Cabalise a project by creating a .cabal, Setup.hs, and "
      ++ "optionally a LICENSE file.\n\n"
      ++ "Calling init with no arguments (recommended) uses an "
      ++ "interactive mode, which will try to guess as much as "
      ++ "possible and prompt you for the rest.  Command-line "
      ++ "arguments are provided for scripting purposes. "
      ++ "If you don't want interactive mode, be sure to pass "
      ++ "the -n flag.\n",
    commandUsage = \pname ->
         "Usage: " ++ pname ++ " init [FLAGS]\n\n"
      ++ "Flags for init:",
965 966
    commandDefaultFlags = defaultInitFlags,
    commandOptions = \_ ->
967
      [ option ['n'] ["non-interactive"]
968 969 970 971 972 973 974 975 976
        "Non-interactive mode."
        IT.nonInteractive (\v flags -> flags { IT.nonInteractive = v })
        trueArg

      , option ['q'] ["quiet"]
        "Do not generate log messages to stdout."
        IT.quiet (\v flags -> flags { IT.quiet = v })
        trueArg

977
      , option [] ["no-comments"]
978 979 980 981 982
        "Do not generate explanatory comments in the .cabal file."
        IT.noComments (\v flags -> flags { IT.noComments = v })
        trueArg

      , option ['m'] ["minimal"]
983
        "Generate a minimal .cabal file, that is, do not include extra empty fields.  Also implies --no-comments."
984 985 986
        IT.minimal (\v flags -> flags { IT.minimal = v })
        trueArg

987 988 989 990 991
      , option [] ["overwrite"]
        "Overwrite any existing .cabal, LICENSE, or Setup.hs files without warning."
        IT.overwrite (\v flags -> flags { IT.overwrite = v })
        trueArg

992
      , option [] ["package-dir"]
993 994 995 996
        "Root directory of the package (default = current directory)."
        IT.packageDir (\v flags -> flags { IT.packageDir = v })
        (reqArgFlag "DIRECTORY")

997
      , option ['p'] ["package-name"]
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
        "Name of the Cabal package to create."
        IT.packageName (\v flags -> flags { IT.packageName = v })
        (reqArgFlag "PACKAGE")

      , option [] ["version"]
        "Initial version of the package."
        IT.version (\v flags -> flags { IT.version = v })
        (reqArg "VERSION" (readP_to_E ("Cannot parse package version: "++)
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))

1009
      , option [] ["cabal-version"]
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
        "Required version of the Cabal library."
        IT.cabalVersion (\v flags -> flags { IT.cabalVersion = v })
        (reqArg "VERSION_RANGE" (readP_to_E ("Cannot parse Cabal version range: "++)
                                            (toFlag `fmap` parse))
                                (flagToList . fmap display))

      , option ['l'] ["license"]
        "Project license."
        IT.license (\v flags -> flags { IT.license = v })
        (reqArg "LICENSE" (readP_to_E ("Cannot parse license: "++)
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))

      , option ['a'] ["author"]
        "Name of the project's author."
        IT.author (\v flags -> flags { IT.author = v })
        (reqArgFlag "NAME")

      , option ['e'] ["email"]
        "Email address of the maintainer."
        IT.email (\v flags -> flags { IT.email = v })
        (reqArgFlag "EMAIL")

      , option ['u'] ["homepage"]
        "Project homepage and/or repository."
        IT.homepage (\v flags -> flags { IT.homepage = v })
        (reqArgFlag "URL")

      , option ['s'] ["synopsis"]
        "Short project synopsis."
        IT.synopsis (\v flags -> flags { IT.synopsis = v })
        (reqArgFlag "TEXT")

      , option ['c'] ["category"]
        "Project category."
        IT.category (\v flags -> flags { IT.category = v })
        (reqArg' "CATEGORY" (\s -> toFlag $ maybe (Left s) Right (readMaybe s))
                            (flagToList . fmap (either id show)))

1049
      , option [] ["is-library"]