Setup.hs 47.2 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
    , installCommand, InstallFlags(..), installOptions, defaultInstallFlags
19
    , listCommand, ListFlags(..)
Duncan Coutts's avatar
Duncan Coutts committed
20
    , updateCommand
ijones's avatar
ijones committed
21
    , upgradeCommand
22
    , infoCommand, InfoFlags(..)
23
    , fetchCommand, FetchFlags(..)
24
    , checkCommand
25
    , uploadCommand, UploadFlags(..)
26
    , reportCommand, ReportFlags(..)
27
    , unpackCommand, UnpackFlags(..)
28
    , initCommand, IT.InitFlags(..)
29
    , sdistCommand, SDistFlags(..), SDistExFlags(..), ArchiveFormat(..)
30
    , win32SelfUpgradeCommand, Win32SelfUpgradeFlags(..)
Duncan Coutts's avatar
Duncan Coutts committed
31 32

    , parsePackageArgs
33 34 35
    --TODO: stop exporting these:
    , showRepo
    , parseRepo
36 37
    ) where

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

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

76 77
import Data.Char
         ( isSpace, isAlphaNum )
78 79
import Data.List
         ( intercalate )
80
import Data.Maybe
81
         ( listToMaybe, maybeToList, fromMaybe )
82 83 84 85 86 87 88 89
import Data.Monoid
         ( Monoid(..) )
import Control.Monad
         ( liftM )
import System.FilePath
         ( (</>) )
import Network.URI
         ( parseAbsoluteURI, uriToString )
90

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

107 108 109 110 111 112 113
defaultGlobalFlags :: GlobalFlags
defaultGlobalFlags  = GlobalFlags {
    globalVersion        = Flag False,
    globalNumericVersion = Flag False,
    globalConfigFile     = mempty,
    globalRemoteRepos    = [],
    globalCacheDir       = mempty,
114
    globalLocalRepos     = mempty,
115
    globalLogsDir        = mempty,
116
    globalWorldFile      = mempty
117 118 119 120 121 122
  }

globalCommand :: CommandUI GlobalFlags
globalCommand = CommandUI {
    commandName         = "",
    commandSynopsis     = "",
123 124 125 126
    commandUsage        = \_ ->
         "This program is the command line interface "
           ++ "to the Haskell Cabal infrastructure.\n"
      ++ "See http://www.haskell.org/cabal/ for more information.\n",
127
    commandDescription  = Just $ \pname ->
128 129 130 131 132 133
         "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",
134 135 136 137 138 139 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
    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)
166

167 168 169 170 171
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

172 173 174 175
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
176 177 178 179 180 181 182 183 184 185
      ]
  }

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

218
configureCommand :: CommandUI ConfigFlags
219
configureCommand = (Cabal.configureCommand defaultProgramConfiguration) {
220
    commandDefaultFlags = mempty
Duncan Coutts's avatar
Duncan Coutts committed
221 222
  }

223 224 225
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

226
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
227 228 229
filterConfigureFlags flags cabalLibVersion
  | cabalLibVersion >= Version [1,3,10] [] = flags
    -- older Cabal does not grok the constraints flag:
230
  | otherwise = flags { configConstraints = [] }
231

232 233 234 235 236 237 238 239
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
240
    configExConstraints:: [UserConstraint],
241
    configPreferences  :: [Dependency],
242
    configSolver       :: Flag PreSolver
243 244 245
  }

defaultConfigExFlags :: ConfigExFlags
246
defaultConfigExFlags = mempty { configSolver = Flag defaultSolver }
247 248 249 250 251

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

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
279 280 281 282
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
283 284

  , optionSolver configSolver (\v flags -> flags { configSolver = v })
285 286 287 288 289
  ]

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
290
    configExConstraints= mempty,
291 292
    configPreferences  = mempty,
    configSolver       = mempty
293 294 295
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
296
    configExConstraints= combine configExConstraints,
297 298
    configPreferences  = combine configPreferences,
    configSolver       = combine configSolver
299 300 301
  }
    where combine field = field a `mappend` field b

302
-- ------------------------------------------------------------
303
-- * Fetch command
304
-- ------------------------------------------------------------
305

306 307 308 309
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
310
      fetchSolver           :: Flag PreSolver,
311 312 313
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
314
      fetchShadowPkgs       :: Flag Bool,
315 316 317 318 319 320 321 322
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
323 324 325 326
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
    fetchReorderGoals     = Flag False,
    fetchIndependentGoals = Flag False,
327
    fetchShadowPkgs       = Flag False,
328 329 330 331
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
332 333
fetchCommand = CommandUI {
    commandName         = "fetch",
334
    commandSynopsis     = "Downloads packages for later installation.",
Duncan Coutts's avatar
Duncan Coutts committed
335 336
    commandDescription  = Nothing,
    commandUsage        = usagePackages "fetch",
337
    commandDefaultFlags = defaultFetchFlags,
338
    commandOptions      = \ showOrParseArgs -> [
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
         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
360 361 362 363

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
364 365
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
366 367
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
368
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
369

Duncan Coutts's avatar
Duncan Coutts committed
370 371
  }

372 373 374 375
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

376
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
377 378 379 380 381
updateCommand = CommandUI {
    commandName         = "update",
    commandSynopsis     = "Updates list of known packages",
    commandDescription  = Nothing,
    commandUsage        = usagePackages "update",
382
    commandDefaultFlags = toFlag normal,
383
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
384 385
  }

386
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
387
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
388
    commandName         = "upgrade",
389
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
390
    commandDescription  = Nothing,
391
    commandUsage        = usagePackages "upgrade",
392
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
393
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
394 395
  }

Duncan Coutts's avatar
Duncan Coutts committed
396 397 398 399 400 401 402 403 404 405 406
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

407 408 409 410 411 412
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
    commandSynopsis     = "Check the package for common mistakes",
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
413
    commandDefaultFlags = toFlag normal,
414
    commandOptions      = \_ -> []
415 416
  }

417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
-- ------------------------------------------------------------
-- * 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
435 436 437
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
    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))
      ]
458 459
  }

460 461 462 463 464 465 466 467 468 469 470 471 472
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

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

513 514 515 516 517 518
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
    listInstalled :: Flag Bool,
519
    listSimpleOutput :: Flag Bool,
520 521 522 523 524 525
    listVerbosity :: Flag Verbosity
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
    listInstalled = Flag False,
526
    listSimpleOutput = Flag False,
527 528 529 530 531 532
    listVerbosity = toFlag normal
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
533
    commandSynopsis     = "List packages matching a search string.",
534 535
    commandDescription  = Nothing,
    commandUsage        = usagePackages "list",
536
    commandDefaultFlags = defaultListFlags,
537
    commandOptions      = \_ -> [
538
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
539

540
        , option [] ["installed"]
541 542 543 544
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

545 546 547 548 549
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

550 551 552 553 554 555 556
        ]
  }

instance Monoid ListFlags where
  mempty = defaultListFlags
  mappend a b = ListFlags {
    listInstalled = combine listInstalled,
557
    listSimpleOutput = combine listSimpleOutput,
558 559 560 561
    listVerbosity = combine listVerbosity
  }
    where combine field = field a `mappend` field b

562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
-- ------------------------------------------------------------
-- * 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

594 595 596 597
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

598 599
-- | Install takes the same flags as configure along with a few extras.
--
600
data InstallFlags = InstallFlags {
601 602 603
    installDocumentation    :: Flag Bool,
    installHaddockIndex     :: Flag PathTemplate,
    installDryRun           :: Flag Bool,
604 605 606
    installMaxBackjumps     :: Flag Int,
    installReorderGoals     :: Flag Bool,
    installIndependentGoals :: Flag Bool,
607
    installShadowPkgs       :: Flag Bool,
608 609
    installReinstall        :: Flag Bool,
    installAvoidReinstalls  :: Flag Bool,
610
    installOverrideReinstall :: Flag Bool,
611 612 613 614 615 616 617 618
    installUpgradeDeps      :: Flag Bool,
    installOnly             :: Flag Bool,
    installOnlyDeps         :: Flag Bool,
    installRootCmd          :: Flag String,
    installSummaryFile      :: [PathTemplate],
    installLogFile          :: Flag PathTemplate,
    installBuildReports     :: Flag ReportLevel,
    installSymlinkBinDir    :: Flag FilePath,
619 620
    installOneShot          :: Flag Bool,
    installNumJobs          :: Flag Int
621 622 623 624
  }

defaultInstallFlags :: InstallFlags
defaultInstallFlags = InstallFlags {
625 626 627
    installDocumentation   = Flag False,
    installHaddockIndex    = Flag docIndexFile,
    installDryRun          = Flag False,
628 629 630
    installMaxBackjumps    = Flag defaultMaxBackjumps,
    installReorderGoals    = Flag False,
    installIndependentGoals= Flag False,
631
    installShadowPkgs      = Flag False,
632 633
    installReinstall       = Flag False,
    installAvoidReinstalls = Flag False,
634
    installOverrideReinstall = Flag False,
635 636 637 638 639 640 641 642
    installUpgradeDeps     = Flag False,
    installOnly            = Flag False,
    installOnlyDeps        = Flag False,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = Flag NoReports,
    installSymlinkBinDir   = mempty,
643 644
    installOneShot         = Flag False,
    installNumJobs         = Flag 1
645
  }
646 647
  where
    docIndexFile = toPathTemplate ("$datadir" </> "doc" </> "index.html")
648

649 650 651
defaultMaxBackjumps :: Int
defaultMaxBackjumps = 200

652 653
defaultSolver :: PreSolver
defaultSolver = Choose
654 655

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

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

    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",
699 700
                       "hyperlink-source", "hscolour-css",
                       "contents-location"]
701 702 703 704 705 706 707
        ]

    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
708 709 710 711

installOptions ::  ShowOrParseArgs -> [OptionField InstallFlags]
installOptions showOrParseArgs =
      [ option "" ["documentation"]
712 713 714 715
          "building of documentation"
          installDocumentation (\v flags -> flags { installDocumentation = v })
          (boolOpt [] [])

716 717
      , option [] ["doc-index-file"]
          "A central index of haddock API documentation (template cannot use $pkgid)"
718 719 720
          installHaddockIndex (\v flags -> flags { installHaddockIndex = v })
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
721

722
      , option [] ["dry-run"]
723 724 725
          "Do not install anything, only print what would be installed."
          installDryRun (\v flags -> flags { installDryRun = v })
          trueArg
726
      ] ++
727

728 729
      optionSolverFlags showOrParseArgs
                        installMaxBackjumps     (\v flags -> flags { installMaxBackjumps     = v })
730
                        installReorderGoals     (\v flags -> flags { installReorderGoals     = v })
731 732
                        installIndependentGoals (\v flags -> flags { installIndependentGoals = v })
                        installShadowPkgs       (\v flags -> flags { installShadowPkgs       = v }) ++
733

734
      [ option [] ["reinstall"]
735 736
          "Install even if it means installing the same version again."
          installReinstall (\v flags -> flags { installReinstall = v })
737
          (yesNoOpt showOrParseArgs)
738

739 740 741
      , option [] ["avoid-reinstalls"]
          "Do not select versions that would destructively overwrite installed packages."
          installAvoidReinstalls (\v flags -> flags { installAvoidReinstalls = v })
742
          (yesNoOpt showOrParseArgs)
743

744
      , option [] ["force-reinstalls"]
745
          "Reinstall packages even if they will most likely break other installed packages."
746
          installOverrideReinstall (\v flags -> flags { installOverrideReinstall = v })
747
          (yesNoOpt showOrParseArgs)
748

749 750 751
      , option [] ["upgrade-dependencies"]
          "Pick the latest version for all dependencies, rather than trying to pick an installed version."
          installUpgradeDeps (\v flags -> flags { installUpgradeDeps = v })
752
          (yesNoOpt showOrParseArgs)
753

754 755 756
      , option [] ["only-dependencies"]
          "Install only the dependencies necessary to build the given packages"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
757
          (yesNoOpt showOrParseArgs)
758

759 760 761 762 763
      , option [] ["root-cmd"]
          "Command used to gain root privileges, when installing with --global."
          installRootCmd (\v flags -> flags { installRootCmd = v })
          (reqArg' "COMMAND" toFlag flagToList)

764 765 766 767 768
      , option [] ["symlink-bindir"]
          "Add symlinks to installed executables into this directory."
           installSymlinkBinDir (\v flags -> flags { installSymlinkBinDir = v })
           (reqArgFlag "DIR")

769 770 771 772 773 774
      , 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
775 776
          "Log all builds to file (name template can use $pkgid, $compiler, $os, $arch)"
          installLogFile (\v flags -> flags { installLogFile = v })
777 778
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
Duncan Coutts's avatar
Duncan Coutts committed
779

780 781
      , option [] ["remote-build-reporting"]
          "Generate build reports to send to a remote server (none, anonymous or detailed)."
782
          installBuildReports (\v flags -> flags { installBuildReports = v })
783 784 785 786
          (reqArg "LEVEL" (readP_to_E (const $ "report level must be 'none', "
                                            ++ "'anonymous' or 'detailed'")
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))
787

788 789 790
      , option [] ["one-shot"]
          "Do not record the packages in the world file."
          installOneShot (\v flags -> flags { installOneShot = v })
791
          (yesNoOpt showOrParseArgs)
792 793

      , option "j" ["jobs"]
794
        "Run NUM jobs simultaneously."
795
        installNumJobs (\v flags -> flags { installNumJobs = v })
796 797 798
        (reqArg "NUM" (readP_to_E (\_ -> "jobs should be a number")
                                  (fmap toFlag (Parse.readS_to_P reads)))
                      (map show . flagToList))
799 800 801 802 803 804 805
      ] ++ 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
             : []
806
          _ -> []
807 808

instance Monoid InstallFlags where
809
  mempty = InstallFlags {
810 811 812 813 814
    installDocumentation   = mempty,
    installHaddockIndex    = mempty,
    installDryRun          = mempty,
    installReinstall       = mempty,
    installAvoidReinstalls = mempty,
815
    installOverrideReinstall = mempty,
Andres Löh's avatar
Andres Löh committed
816
    installMaxBackjumps    = mempty,
817
    installUpgradeDeps     = mempty,
Andres Löh's avatar
Andres Löh committed
818
    installReorderGoals    = mempty,
819
    installIndependentGoals= mempty,
820
    installShadowPkgs      = mempty,
821 822 823 824 825 826 827
    installOnly            = mempty,
    installOnlyDeps        = mempty,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = mempty,
    installSymlinkBinDir   = mempty,
828 829
    installOneShot         = mempty,
    installNumJobs         = mempty
830
  }
831
  mappend a b = InstallFlags {
832 833 834 835 836
    installDocumentation   = combine installDocumentation,
    installHaddockIndex    = combine installHaddockIndex,
    installDryRun          = combine installDryRun,
    installReinstall       = combine installReinstall,
    installAvoidReinstalls = combine installAvoidReinstalls,
837
    installOverrideReinstall = combine installOverrideReinstall,
Andres Löh's avatar
Andres Löh committed
838
    installMaxBackjumps    = combine installMaxBackjumps,
839
    installUpgradeDeps     = combine installUpgradeDeps,
Andres Löh's avatar
Andres Löh committed
840
    installReorderGoals    = combine installReorderGoals,
841
    installIndependentGoals= combine installIndependentGoals,
842
    installShadowPkgs      = combine installShadowPkgs,
843 844 845 846 847 848 849
    installOnly            = combine installOnly,
    installOnlyDeps        = combine installOnlyDeps,
    installRootCmd         = combine installRootCmd,
    installSummaryFile     = combine installSummaryFile,
    installLogFile         = combine installLogFile,
    installBuildReports    = combine installBuildReports,
    installSymlinkBinDir   = combine installSymlinkBinDir,
850 851
    installOneShot         = combine installOneShot,
    installNumJobs         = combine installNumJobs
852 853 854
  }
    where combine field = field a `mappend` field b

855 856 857 858 859 860 861 862 863
-- ------------------------------------------------------------
-- * Upload flags
-- ------------------------------------------------------------

data UploadFlags = UploadFlags {
    uploadCheck     :: Flag Bool,
    uploadUsername  :: Flag Username,
    uploadPassword  :: Flag Password,
    uploadVerbosity :: Flag Verbosity
864
  }
865 866 867 868 869 870 871 872 873 874 875 876 877 878

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 $ \_ ->
879
         "You can store your Hackage login in the ~/.cabal/config file\n",
880 881 882 883 884
    commandUsage        = \pname ->
         "Usage: " ++ pname ++ " upload [FLAGS] [TARFILES]\n\n"
      ++ "Flags for upload:",
    commandDefaultFlags = defaultUploadFlags,
    commandOptions      = \_ ->
885
      [optionVerbosity uploadVerbosity (\v flags -> flags { uploadVerbosity = v })
886 887 888 889

      ,option ['c'] ["check"]
         "Do not upload, just do QA checks."
        uploadCheck (\v flags -> flags { uploadCheck = v })
890
        trueArg
891 892 893 894

      ,option ['u'] ["username"]
        "Hackage username."
        uploadUsername (\v flags -> flags { uploadUsername = v })
895 896
        (reqArg' "USERNAME" (toFlag . Username)
                            (flagToList . fmap unUsername))
897 898 899 900

      ,option ['p'] ["password"]
        "Hackage password."
        uploadPassword (\v flags -> flags { uploadPassword = v })
901 902
        (reqArg' "PASSWORD" (toFlag . Password)
                            (flagToList . fmap unPassword))
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
      ]
  }

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

921 922 923 924 925 926 927 928
-- ------------------------------------------------------------
-- * Init flags
-- ------------------------------------------------------------

emptyInitFlags :: IT.InitFlags
emptyInitFlags  = mempty

defaultInitFlags :: IT.InitFlags
929
defaultInitFlags  = emptyInitFlags { IT.initVerbosity = toFlag normal }
930 931 932 933 934

initCommand :: CommandUI IT.InitFlags
initCommand = CommandUI {
    commandName = "init",
    commandSynopsis = "Interactively create a .cabal file.",
935 936 937 938 939 940 941 942 943 944 945 946
    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:",
947 948
    commandDefaultFlags = defaultInitFlags,
    commandOptions = \_ ->
949
      [ option ['n'] ["non-interactive"]
950 951 952 953 954 955 956 957 958
        "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

959
      , option [] ["no-comments"]
960 961 962 963 964
        "Do not generate explanatory comments in the .cabal file."
        IT.noComments (\v flags -> flags { IT.noComments = v })
        trueArg

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

969
      , option [] ["package-dir"]
970 971 972 973
        "Root directory of the package (default = current directory)."
        IT.packageDir (\v flags -> flags { IT.packageDir = v })
        (reqArgFlag "DIRECTORY")

974
      , option ['p'] ["package-name"]
975 976 977 978 979 980 981 982 983 984 985
        "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))

986
      , option [] ["cabal-version"]
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
        "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)))

1026
      , option [] ["is-library"]
1027 1028 1029 1030
        "Build a library."
        IT.packageType (\v flags -> flags { IT.packageType = v })
        (noArg (Flag IT.Library))

1031
      , option [] ["is-executable"]
1032 1033 1034 1035 1036
        "Build an executable."
        IT.packageType
        (\v flags -> flags { IT.packageType = v })
        (noArg (Flag IT.Executable))

1037
      , option ['o'] ["expose-module"]
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
        "Export a module from the package."
        IT.exposedModules
        (\v flags -> flags { IT.exposedModules = v })
        (reqArg "MODULE" (readP_to_E ("Cannot parse module name: "++)
                                     ((Just . (:[])) `fmap` parse))
                         (fromMaybe [] . fmap (fmap display)))

      , option ['d'] ["dependency"]
        "Package dependency."
        IT.dependencies (\v flags -> flags { IT.dependencies = v })
        (reqArg "PACKAGE" (readP_to_E ("Cannot parse dependency: "++)
                                      ((Just . (:[])) `fmap` parse))
                          (fromMaybe [] . fmap (fmap display)))

1052