Setup.hs 36.6 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(..)
Duncan Coutts's avatar
Duncan Coutts committed
29 30

    , parsePackageArgs
31 32 33
    --TODO: stop exporting these:
    , showRepo
    , parseRepo
34 35
    ) where

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

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

73 74 75
import Data.Char
         ( isSpace, isAlphaNum )
import Data.Maybe
76
         ( listToMaybe, maybeToList, fromMaybe )
77 78 79 80 81 82 83 84
import Data.Monoid
         ( Monoid(..) )
import Control.Monad
         ( liftM )
import System.FilePath
         ( (</>) )
import Network.URI
         ( parseAbsoluteURI, uriToString )
85

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

102 103 104 105 106 107 108
defaultGlobalFlags :: GlobalFlags
defaultGlobalFlags  = GlobalFlags {
    globalVersion        = Flag False,
    globalNumericVersion = Flag False,
    globalConfigFile     = mempty,
    globalRemoteRepos    = [],
    globalCacheDir       = mempty,
109
    globalLocalRepos     = mempty,
110
    globalLogsDir        = mempty,
111
    globalWorldFile      = mempty
112 113 114 115 116 117
  }

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

162 163 164 165 166
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

167 168 169 170
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
171 172 173 174 175 176 177 178 179 180
      ]
  }

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

213
configureCommand :: CommandUI ConfigFlags
214
configureCommand = (Cabal.configureCommand defaultProgramConfiguration) {
215
    commandDefaultFlags = mempty
Duncan Coutts's avatar
Duncan Coutts committed
216 217
  }

218 219 220
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

221
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
222 223 224
filterConfigureFlags flags cabalLibVersion
  | cabalLibVersion >= Version [1,3,10] [] = flags
    -- older Cabal does not grok the constraints flag:
225
  | otherwise = flags { configConstraints = [] }
226

227 228 229 230 231 232 233 234 235

-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

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

defaultConfigExFlags :: ConfigExFlags
defaultConfigExFlags = mempty

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

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

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
283
    configExConstraints= mempty,
284 285 286 287
    configPreferences  = mempty
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
288
    configExConstraints= combine configExConstraints,
289 290 291 292
    configPreferences  = combine configPreferences
  }
    where combine field = field a `mappend` field b

293
-- ------------------------------------------------------------
294
-- * Fetch command
295
-- ------------------------------------------------------------
296

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
313 314
fetchCommand = CommandUI {
    commandName         = "fetch",
315
    commandSynopsis     = "Downloads packages for later installation.",
Duncan Coutts's avatar
Duncan Coutts committed
316 317
    commandDescription  = Nothing,
    commandUsage        = usagePackages "fetch",
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
    commandDefaultFlags = defaultFetchFlags,
    commandOptions      = \_ -> [
         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
       ]
Duncan Coutts's avatar
Duncan Coutts committed
342 343
  }

344 345 346 347
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

348
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
349 350 351 352 353
updateCommand = CommandUI {
    commandName         = "update",
    commandSynopsis     = "Updates list of known packages",
    commandDescription  = Nothing,
    commandUsage        = usagePackages "update",
354
    commandDefaultFlags = toFlag normal,
355
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
356 357
  }

358
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags)
359
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
360
    commandName         = "upgrade",
361
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
362
    commandDescription  = Nothing,
363
    commandUsage        = usagePackages "upgrade",
364
    commandDefaultFlags = (mempty, mempty, mempty),
365
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
366 367
  }

Duncan Coutts's avatar
Duncan Coutts committed
368 369 370 371 372 373 374 375 376 377 378
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

379 380 381 382 383 384
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
    commandSynopsis     = "Check the package for common mistakes",
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
385
    commandDefaultFlags = toFlag normal,
386
    commandOptions      = \_ -> []
387 388
  }

389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
-- ------------------------------------------------------------
-- * 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
407 408 409
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
    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))
      ]
430 431
  }

432 433 434 435 436 437 438 439 440 441 442 443 444
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

445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
-- ------------------------------------------------------------
-- * 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

485 486 487 488 489 490
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
    listInstalled :: Flag Bool,
491
    listSimpleOutput :: Flag Bool,
492 493 494 495 496 497
    listVerbosity :: Flag Verbosity
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
    listInstalled = Flag False,
498
    listSimpleOutput = Flag False,
499 500 501 502 503 504
    listVerbosity = toFlag normal
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
505
    commandSynopsis     = "List packages matching a search string.",
506 507
    commandDescription  = Nothing,
    commandUsage        = usagePackages "list",
508
    commandDefaultFlags = defaultListFlags,
509
    commandOptions      = \_ -> [
510
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
511

512
        , option [] ["installed"]
513 514 515 516
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

517 518 519 520 521
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

522 523 524 525 526 527 528
        ]
  }

instance Monoid ListFlags where
  mempty = defaultListFlags
  mappend a b = ListFlags {
    listInstalled = combine listInstalled,
529
    listSimpleOutput = combine listSimpleOutput,
530 531 532 533
    listVerbosity = combine listVerbosity
  }
    where combine field = field a `mappend` field b

534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
-- ------------------------------------------------------------
-- * 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

566 567 568 569
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

570 571
-- | Install takes the same flags as configure along with a few extras.
--
572
data InstallFlags = InstallFlags {
573
    installDocumentation:: Flag Bool,
574
    installHaddockIndex :: Flag PathTemplate,
575
    installDryRun       :: Flag Bool,
576
    installReinstall    :: Flag Bool,
577
    installUpgradeDeps  :: Flag Bool,
578
    installOnly         :: Flag Bool,
579
    installOnlyDeps     :: Flag Bool,
580
    installRootCmd      :: Flag String,
581 582 583
    installSummaryFile  :: [PathTemplate],
    installLogFile      :: Flag PathTemplate,
    installBuildReports :: Flag ReportLevel,
584 585
    installSymlinkBinDir:: Flag FilePath,
    installOneShot      :: Flag Bool
586 587 588 589
  }

defaultInstallFlags :: InstallFlags
defaultInstallFlags = InstallFlags {
590
    installDocumentation= Flag False,
591
    installHaddockIndex = Flag docIndexFile,
592
    installDryRun       = Flag False,
593
    installReinstall    = Flag False,
594
    installUpgradeDeps  = Flag False,
595
    installOnly         = Flag False,
596
    installOnlyDeps     = Flag False,
597
    installRootCmd      = mempty,
598
    installSummaryFile  = mempty,
599
    installLogFile      = mempty,
600
    installBuildReports = Flag NoReports,
601 602
    installSymlinkBinDir= mempty,
    installOneShot      = Flag False
603
  }
604 605
  where
    docIndexFile = toPathTemplate ("$datadir" </> "doc" </> "index.html")
606

607 608
installCommand :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags)
installCommand = CommandUI {
609 610 611
  commandName         = "install",
  commandSynopsis     = "Installs a list of packages.",
  commandUsage        = usagePackages "install",
612 613 614 615 616
  commandDescription  = Just $ \pname ->
    let original = case commandDescription configureCommand of
          Just desc -> desc pname ++ "\n"
          Nothing   -> ""
     in original
617
     ++ "Examples:\n"
618 619 620 621 622 623 624 625
     ++ "  " ++ 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",
626
  commandDefaultFlags = (mempty, mempty, mempty),
627
  commandOptions      = \showOrParseArgs ->
628 629
       liftOptions get1 set1 (filter ((/="constraint") . optionName) $
                              configureOptions   showOrParseArgs)
630 631
    ++ liftOptions get2 set2 (configureExOptions showOrParseArgs)
    ++ liftOptions get3 set3 (installOptions     showOrParseArgs)
632
  }
633 634 635 636
  where
    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)
637 638 639 640

installOptions ::  ShowOrParseArgs -> [OptionField InstallFlags]
installOptions showOrParseArgs =
      [ option "" ["documentation"]
641 642 643 644
          "building of documentation"
          installDocumentation (\v flags -> flags { installDocumentation = v })
          (boolOpt [] [])

645 646
      , option [] ["doc-index-file"]
          "A central index of haddock API documentation (template cannot use $pkgid)"
647 648 649
          installHaddockIndex (\v flags -> flags { installHaddockIndex = v })
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
650

651
      , option [] ["dry-run"]
652 653 654
          "Do not install anything, only print what would be installed."
          installDryRun (\v flags -> flags { installDryRun = v })
          trueArg
655

656 657 658 659 660
      , option [] ["reinstall"]
          "Install even if it means installing the same version again."
          installReinstall (\v flags -> flags { installReinstall = v })
          trueArg

661 662 663 664 665
      , option [] ["upgrade-dependencies"]
          "Pick the latest version for all dependencies, rather than trying to pick an installed version."
          installUpgradeDeps (\v flags -> flags { installUpgradeDeps = v })
          trueArg

666 667 668 669 670 671 672

      , option [] ["only-dependencies"]
          "Install only the dependencies necessary to build the given packages"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
          trueArg


673 674 675 676 677
      , option [] ["root-cmd"]
          "Command used to gain root privileges, when installing with --global."
          installRootCmd (\v flags -> flags { installRootCmd = v })
          (reqArg' "COMMAND" toFlag flagToList)

678 679 680 681 682
      , option [] ["symlink-bindir"]
          "Add symlinks to installed executables into this directory."
           installSymlinkBinDir (\v flags -> flags { installSymlinkBinDir = v })
           (reqArgFlag "DIR")

683 684 685 686 687 688
      , 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
689 690
          "Log all builds to file (name template can use $pkgid, $compiler, $os, $arch)"
          installLogFile (\v flags -> flags { installLogFile = v })
691 692
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
Duncan Coutts's avatar
Duncan Coutts committed
693

694 695
      , option [] ["remote-build-reporting"]
          "Generate build reports to send to a remote server (none, anonymous or detailed)."
696
          installBuildReports (\v flags -> flags { installBuildReports = v })
697 698 699 700
          (reqArg "LEVEL" (readP_to_E (const $ "report level must be 'none', "
                                            ++ "'anonymous' or 'detailed'")
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))
701

702 703 704 705
      , option [] ["one-shot"]
          "Do not record the packages in the world file."
          installOneShot (\v flags -> flags { installOneShot = v })
          trueArg
706 707 708 709 710 711 712
      ] ++ 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
             : []
713
          _ -> []
714 715

instance Monoid InstallFlags where
716 717
  mempty = InstallFlags {
    installDocumentation= mempty,
718
    installHaddockIndex = mempty,
719 720
    installDryRun       = mempty,
    installReinstall    = mempty,
721
    installUpgradeDeps  = mempty,
722
    installOnly         = mempty,
723
    installOnlyDeps     = mempty,
724
    installRootCmd      = mempty,
725
    installSummaryFile  = mempty,
726 727
    installLogFile      = mempty,
    installBuildReports = mempty,
728 729
    installSymlinkBinDir= mempty,
    installOneShot      = mempty
730
  }
731
  mappend a b = InstallFlags {
732
    installDocumentation= combine installDocumentation,
733
    installHaddockIndex = combine installHaddockIndex,
734
    installDryRun       = combine installDryRun,
735
    installReinstall    = combine installReinstall,
736
    installUpgradeDeps  = combine installUpgradeDeps,
737
    installOnly         = combine installOnly,
738
    installOnlyDeps     = combine installOnlyDeps,
739
    installRootCmd      = combine installRootCmd,
740
    installSummaryFile  = combine installSummaryFile,
741
    installLogFile      = combine installLogFile,
742
    installBuildReports = combine installBuildReports,
743 744
    installSymlinkBinDir= combine installSymlinkBinDir,
    installOneShot      = combine installOneShot
745 746 747
  }
    where combine field = field a `mappend` field b

748 749 750 751 752 753 754 755 756
-- ------------------------------------------------------------
-- * Upload flags
-- ------------------------------------------------------------

data UploadFlags = UploadFlags {
    uploadCheck     :: Flag Bool,
    uploadUsername  :: Flag Username,
    uploadPassword  :: Flag Password,
    uploadVerbosity :: Flag Verbosity
757
  }
758 759 760 761 762 763 764 765 766 767 768 769 770 771

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 $ \_ ->
772
         "You can store your Hackage login in the ~/.cabal/config file\n",
773 774 775 776 777
    commandUsage        = \pname ->
         "Usage: " ++ pname ++ " upload [FLAGS] [TARFILES]\n\n"
      ++ "Flags for upload:",
    commandDefaultFlags = defaultUploadFlags,
    commandOptions      = \_ ->
778
      [optionVerbosity uploadVerbosity (\v flags -> flags { uploadVerbosity = v })
779 780 781 782

      ,option ['c'] ["check"]
         "Do not upload, just do QA checks."
        uploadCheck (\v flags -> flags { uploadCheck = v })
783
        trueArg
784 785 786 787

      ,option ['u'] ["username"]
        "Hackage username."
        uploadUsername (\v flags -> flags { uploadUsername = v })
788 789
        (reqArg' "USERNAME" (toFlag . Username)
                            (flagToList . fmap unUsername))
790 791 792 793

      ,option ['p'] ["password"]
        "Hackage password."
        uploadPassword (\v flags -> flags { uploadPassword = v })
794 795
        (reqArg' "PASSWORD" (toFlag . Password)
                            (flagToList . fmap unPassword))
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
      ]
  }

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

814 815 816 817 818 819 820 821 822 823 824 825 826 827
-- ------------------------------------------------------------
-- * Init flags
-- ------------------------------------------------------------

emptyInitFlags :: IT.InitFlags
emptyInitFlags  = mempty

defaultInitFlags :: IT.InitFlags
defaultInitFlags  = emptyInitFlags

initCommand :: CommandUI IT.InitFlags
initCommand = CommandUI {
    commandName = "init",
    commandSynopsis = "Interactively create a .cabal file.",
828 829 830 831 832 833 834 835 836 837 838 839
    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:",
840 841
    commandDefaultFlags = defaultInitFlags,
    commandOptions = \_ ->
842
      [ option ['n'] ["non-interactive"]
843 844 845 846 847 848 849 850 851
        "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

852
      , option [] ["no-comments"]
853 854 855 856 857
        "Do not generate explanatory comments in the .cabal file."
        IT.noComments (\v flags -> flags { IT.noComments = v })
        trueArg

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

862
      , option [] ["package-dir"]
863 864 865 866
        "Root directory of the package (default = current directory)."
        IT.packageDir (\v flags -> flags { IT.packageDir = v })
        (reqArgFlag "DIRECTORY")

867
      , option ['p'] ["package-name"]
868 869 870 871 872 873 874 875 876 877 878
        "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))

879
      , option [] ["cabal-version"]
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
        "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)))

919
      , option [] ["is-library"]
920 921 922 923
        "Build a library."
        IT.packageType (\v flags -> flags { IT.packageType = v })
        (noArg (Flag IT.Library))

924
      , option [] ["is-executable"]
925 926 927 928 929
        "Build an executable."
        IT.packageType
        (\v flags -> flags { IT.packageType = v })
        (noArg (Flag IT.Executable))

930
      , option ['o'] ["expose-module"]
931 932 933 934 935 936 937 938 939 940 941 942 943 944
        "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)))

945
      , option [] ["source-dir"]
946 947 948 949 950
        "Directory containing package source."
        IT.sourceDirs (\v flags -> flags { IT.sourceDirs = v })
        (reqArg' "DIR" (Just . (:[]))
                       (fromMaybe []))

951
      , option [] ["build-tool"]
952 953 954 955 956 957 958 959
        "Required external build tool."
        IT.buildTools (\v flags -> flags { IT.buildTools = v })
        (reqArg' "TOOL" (Just . (:[]))
                        (fromMaybe []))
      ]
  }
  where readMaybe s = case reads s of
                        [(x,"")]  -> Just x
960
                        _         -> Nothing
961

962 963 964 965
-- ------------------------------------------------------------
-- * GetOpt Utils
-- ------------------------------------------------------------

966 967 968
boolOpt :: SFlags -> SFlags -> MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a
boolOpt  = Command.boolOpt  flagToMaybe Flag

969 970 971 972
reqArgFlag :: ArgPlaceHolder -> SFlags -> LFlags -> Description ->
              (b -> Flag String) -> (Flag String -> b -> b) -> OptDescr b
reqArgFlag ad = reqArg ad (succeedReadE Flag) flagToList

973 974 975 976
liftOptions :: (b -> a) -> (a -> b -> b)
            -> [OptionField a] -> [OptionField b]
liftOptions get set = map (liftOption get set)

Duncan Coutts's avatar
Duncan Coutts committed
977
usagePackages :: String -> String -> String
978
usagePackages name pname =
Duncan Coutts's avatar
Duncan Coutts committed
979 980 981 982
     "Usage: " ++ pname ++ " " ++ name ++ " [FLAGS]\n"
  ++ "   or: " ++ pname ++ " " ++ name ++ " [PACKAGES]\n\n"
  ++ "Flags for " ++ name ++ ":"

983 984
--TODO: do we want to allow per-package flags?
parsePackageArgs :: [String] -> Either String [Dependency]
Duncan Coutts's avatar
Duncan Coutts committed
985 986 987 988 989
parsePackageArgs = parsePkgArgs []
  where
    parsePkgArgs ds [] = Right (reverse ds)
    parsePkgArgs ds (arg:args) =
      case readPToMaybe parseDependencyOrPackageId arg of
990
        Just dep -> parsePkgArgs (dep:ds) args
991 992 993
        Nothing  -> Left $
         show arg ++ " is not valid syntax for a package name or"
                  ++ " package dependency."
994

995 996 997
readPToMaybe :: Parse.ReadP a a -> String -> Maybe a
readPToMaybe p str = listToMaybe [ r | (r,s) <- Parse.readP_to_S p str
                                     , all isSpace s ]
998

999 1000
parseDependencyOrPackageId :: Parse.ReadP r Dependency
parseDependencyOrPackageId = parse Parse.+++ liftM pkgidToDependency parse
1001 1002 1003
  where
    pkgidToDependency :: PackageIdentifier -> Dependency
    pkgidToDependency p = case packageVersion p of
Duncan Coutts's avatar
Duncan Coutts committed
1004 1005
      Version [] _ -> Dependency (packageName p) anyVersion
      version      -> Dependency (packageName p) (thisVersion version)
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016

showRepo :: RemoteRepo -> String
showRepo repo = remoteRepoName repo ++ ":"
             ++ uriToString id (remoteRepoURI repo) []

readRepo :: String -> Maybe RemoteRepo
readRepo = readPToMaybe parseRepo

parseRepo :: Parse.ReadP r RemoteRepo
parseRepo = do
  name <- Parse.munch1 (\c -> isAlphaNum c || c `elem` "_-.")
1017
  _ <- Parse.char ':'
1018 1019 1020 1021 1022 1023
  uriStr <- Parse.munch1 (\c -> isAlphaNum c || c `elem` "+-=._/*()@'$:;&!?~")
  uri <- maybe Parse.pfail return (parseAbsoluteURI uriStr)
  return $ RemoteRepo {
    remoteRepoName = name,
    remoteRepoURI  = uri
  }