Setup.hs 91.8 KB
Newer Older
1
{-# LANGUAGE CPP #-}
2 3
-----------------------------------------------------------------------------
-- |
4
-- Module      :  Distribution.Client.Setup
5 6 7 8 9 10 11 12 13
-- Copyright   :  (c) David Himmelstrup 2005
-- License     :  BSD-like
--
-- Maintainer  :  lemmih@gmail.com
-- Stability   :  provisional
-- Portability :  portable
--
--
-----------------------------------------------------------------------------
14
module Distribution.Client.Setup
15
    ( globalCommand, GlobalFlags(..), defaultGlobalFlags, globalRepos
16
    , configureCommand, ConfigFlags(..), filterConfigureFlags
17 18
    , configureExCommand, ConfigExFlags(..), defaultConfigExFlags
                        , configureExOptions
19
    , buildCommand, BuildFlags(..), BuildExFlags(..), SkipAddSourceDepsCheck(..)
20
    , replCommand, testCommand, benchmarkCommand
21
    , installCommand, InstallFlags(..), installOptions, defaultInstallFlags
22
    , listCommand, ListFlags(..)
Duncan Coutts's avatar
Duncan Coutts committed
23
    , updateCommand
ijones's avatar
ijones committed
24
    , upgradeCommand
25
    , uninstallCommand
26
    , infoCommand, InfoFlags(..)
27
    , fetchCommand, FetchFlags(..)
28
    , freezeCommand, FreezeFlags(..)
29
    , getCommand, unpackCommand, GetFlags(..)
30
    , checkCommand
31
    , formatCommand
32
    , uploadCommand, UploadFlags(..)
33
    , reportCommand, ReportFlags(..)
refold's avatar
refold committed
34
    , runCommand
35
    , initCommand, IT.InitFlags(..)
36
    , sdistCommand, SDistFlags(..), SDistExFlags(..), ArchiveFormat(..)
37
    , win32SelfUpgradeCommand, Win32SelfUpgradeFlags(..)
38
    , actAsSetupCommand, ActAsSetupFlags(..)
refold's avatar
refold committed
39
    , sandboxCommand, defaultSandboxLocation, SandboxFlags(..)
40
    , execCommand, ExecFlags(..)
41
    , userConfigCommand, UserConfigFlags(..)
Maciek Makowski's avatar
Maciek Makowski committed
42
    , manpageCommand
Duncan Coutts's avatar
Duncan Coutts committed
43 44

    , parsePackageArgs
45 46 47
    --TODO: stop exporting these:
    , showRepo
    , parseRepo
48
    , readRepo
49 50
    ) where

51
import Distribution.Client.Types
Edsko de Vries's avatar
Edsko de Vries committed
52
         ( Username(..), Password(..), Repo(..), RemoteRepo(..) )
53 54
import Distribution.Client.BuildReports.Types
         ( ReportLevel(..) )
55
import Distribution.Client.Dependency.Types
56
         ( AllowNewer(..), PreSolver(..), ConstraintSource(..) )
57 58
import qualified Distribution.Client.Init.Types as IT
         ( InitFlags(..), PackageType(..) )
59 60
import Distribution.Client.Targets
         ( UserConstraint, readUserConstraint )
61 62
import Distribution.Utils.NubList
         ( NubList, toNubList, fromNubList)
63

64
import Distribution.Simple.Compiler (PackageDB)
65 66
import Distribution.Simple.Program
         ( defaultProgramConfiguration )
67 68
import Distribution.Simple.Command hiding (boolOpt, boolOpt')
import qualified Distribution.Simple.Command as Command
Duncan Coutts's avatar
Duncan Coutts committed
69
import qualified Distribution.Simple.Setup as Cabal
70
import Distribution.Simple.Setup
71 72
         ( ConfigFlags(..), BuildFlags(..), ReplFlags
         , TestFlags(..), BenchmarkFlags(..)
73
         , SDistFlags(..), HaddockFlags(..)
74
         , readPackageDbList, showPackageDbList
75
         , Flag(..), toFlag, fromFlag, flagToMaybe, flagToList
76
         , optionVerbosity, boolOpt, boolOpt', trueArg, falseArg, optionNumJobs )
77
import Distribution.Simple.InstallDirs
78 79
         ( PathTemplate, InstallDirs(sysconfdir)
         , toPathTemplate, fromPathTemplate )
80
import Distribution.Version
Duncan Coutts's avatar
Duncan Coutts committed
81
         ( Version(Version), anyVersion, thisVersion )
82
import Distribution.Package
83
         ( PackageIdentifier, packageName, packageVersion, Dependency(..) )
84
import Distribution.PackageDescription
85
         ( BuildType(..), RepoKind(..) )
86
import Distribution.Text
87
         ( Text(..), display )
88
import Distribution.ReadE
89
         ( ReadE(..), readP_to_E, succeedReadE )
90
import qualified Distribution.Compat.ReadP as Parse
91
         ( ReadP, readP_to_S, readS_to_P, char, munch1, pfail, sepBy1, (+++) )
92 93
import Distribution.Verbosity
         ( Verbosity, normal )
94
import Distribution.Simple.Utils
95
         ( wrapText, wrapLine )
96

97 98
import Data.Char
         ( isSpace, isAlphaNum )
99
import Data.List
100
         ( intercalate, deleteFirstsBy )
101
import Data.Maybe
102
         ( listToMaybe, maybeToList, fromMaybe )
103
#if !MIN_VERSION_base(4,8,0)
104 105
import Data.Monoid
         ( Monoid(..) )
106
#endif
107 108 109 110 111 112
import Control.Monad
         ( liftM )
import System.FilePath
         ( (</>) )
import Network.URI
         ( parseAbsoluteURI, uriToString )
113

114 115 116 117 118 119
-- ------------------------------------------------------------
-- * Global flags
-- ------------------------------------------------------------

-- | Flags that apply at the top level, not to any sub-command.
data GlobalFlags = GlobalFlags {
120 121 122 123
    globalVersion           :: Flag Bool,
    globalNumericVersion    :: Flag Bool,
    globalConfigFile        :: Flag FilePath,
    globalSandboxConfigFile :: Flag FilePath,
U-CIQDEV\gbazerman's avatar
U-CIQDEV\gbazerman committed
124
    globalConstraintsFile   :: Flag FilePath,
125
    globalRemoteRepos       :: NubList RemoteRepo,     -- ^ Available Hackage servers.
126
    globalCacheDir          :: Flag FilePath,
127
    globalLocalRepos        :: NubList FilePath,
128
    globalLogsDir           :: Flag FilePath,
129
    globalWorldFile         :: Flag FilePath,
130
    globalRequireSandbox    :: Flag Bool,
131 132
    globalIgnoreSandbox     :: Flag Bool,
    globalHttpTransport     :: Flag String
133
  }
Duncan Coutts's avatar
Duncan Coutts committed
134

135 136
defaultGlobalFlags :: GlobalFlags
defaultGlobalFlags  = GlobalFlags {
137 138 139 140
    globalVersion           = Flag False,
    globalNumericVersion    = Flag False,
    globalConfigFile        = mempty,
    globalSandboxConfigFile = mempty,
U-CIQDEV\gbazerman's avatar
U-CIQDEV\gbazerman committed
141
    globalConstraintsFile   = mempty,
142
    globalRemoteRepos       = mempty,
143 144 145
    globalCacheDir          = mempty,
    globalLocalRepos        = mempty,
    globalLogsDir           = mempty,
146
    globalWorldFile         = mempty,
147
    globalRequireSandbox    = Flag False,
148 149
    globalIgnoreSandbox     = Flag False,
    globalHttpTransport     = mempty
150 151
  }

152 153
globalCommand :: [Command action] -> CommandUI GlobalFlags
globalCommand commands = CommandUI {
154
    commandName         = "",
155 156
    commandSynopsis     =
         "Command line interface to the Haskell Cabal infrastructure.",
157 158 159 160
    commandUsage        = \pname ->
         "See http://www.haskell.org/cabal/ for more information.\n"
      ++ "\n"
      ++ "Usage: " ++ pname ++ " [GLOBAL FLAGS] [COMMAND [FLAGS]]\n",
161
    commandDescription  = Just $ \pname ->
162 163 164
      let
        commands' = commands ++ [commandAddAction helpCommandUI undefined]
        cmdDescs = getNormalCommandDescriptions commands'
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
        -- if new commands are added, we want them to appear even if they
        -- are not included in the custom listing below. Thus, we calculate
        -- the `otherCmds` list and append it under the `other` category.
        -- Alternatively, a new testcase could be added that ensures that
        -- the set of commands listed here is equal to the set of commands
        -- that are actually available.
        otherCmds = deleteFirstsBy (==) (map fst cmdDescs)
          [ "help"
          , "update"
          , "install"
          , "fetch"
          , "list"
          , "info"
          , "user-config"
          , "get"
          , "init"
          , "configure"
          , "build"
          , "clean"
          , "run"
          , "repl"
          , "test"
          , "bench"
          , "check"
          , "sdist"
          , "upload"
          , "report"
          , "freeze"
          , "haddock"
          , "hscolour"
          , "copy"
          , "register"
          , "sandbox"
          , "exec"
          ]
200 201
        maxlen    = maximum $ [length name | (name, _) <- cmdDescs]
        align str = str ++ replicate (maxlen - length str) ' '
202 203 204 205 206 207 208 209 210
        startGroup n = " ["++n++"]"
        par          = ""
        addCmd n     = case lookup n cmdDescs of
                         Nothing -> ""
                         Just d -> "  " ++ align n ++ "    " ++ d
        addCmdCustom n d = case lookup n cmdDescs of -- make sure that the
                                                  -- command still exists.
                         Nothing -> ""
                         Just _ -> "  " ++ align n ++ "    " ++ d
211 212
      in
         "Commands:\n"
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
      ++ unlines (
        [ startGroup "global"
        , addCmd "update"
        , addCmd "install"
        , par
        , addCmd "help"
        , addCmd "info"
        , addCmd "list"
        , addCmd "fetch"
        , addCmd "user-config"
        , par
        , startGroup "package"
        , addCmd "get"
        , addCmd "init"
        , par
        , addCmd "configure"
        , addCmd "build"
        , addCmd "clean"
        , par
        , addCmd "run"
        , addCmd "repl"
        , addCmd "test"
        , addCmd "bench"
        , par
        , addCmd "check"
        , addCmd "sdist"
        , addCmd "upload"
        , addCmd "report"
        , par
        , addCmd "freeze"
        , addCmd "haddock"
        , addCmd "hscolour"
        , addCmd "copy"
        , addCmd "register"
        , par
        , startGroup "sandbox"
249
        , addCmd "sandbox"
250 251 252 253 254
        , addCmd "exec"
        , addCmdCustom "repl" "Open interpreter with access to sandbox packages."
        ] ++ if null otherCmds then [] else par
                                           :startGroup "other"
                                           :[addCmd n | n <- otherCmds])
255 256
      ++ "\n"
      ++ "For more information about a command use:\n"
257 258
      ++ "   " ++ pname ++ " COMMAND --help\n"
      ++ "or " ++ pname ++ " help COMMAND\n"
259
      ++ "\n"
260
      ++ "To install Cabal packages from hackage use:\n"
261 262
      ++ "  " ++ pname ++ " install foo [--dry-run]\n"
      ++ "\n"
263 264
      ++ "Occasionally you need to update the list of available packages:\n"
      ++ "  " ++ pname ++ " update\n",
265
    commandNotes = Nothing,
266
    commandDefaultFlags = mempty,
267 268 269 270 271 272 273 274 275 276 277
    commandOptions = args
  }
  where
    args :: ShowOrParseArgs -> [OptionField GlobalFlags]
    args ShowArgs  = argsShown
    args ParseArgs = argsShown ++ argsNotShown

    -- arguments we want to show in the help
    argsShown :: [OptionField GlobalFlags]
    argsShown = [
       option ['V'] ["version"]
278 279 280 281 282 283 284 285 286 287 288 289 290 291
         "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")

292
      ,option [] ["sandbox-config-file"]
293
         "Set an alternate location for the sandbox config file (default: './cabal.sandbox.config')"
294 295 296
         globalConfigFile (\v flags -> flags { globalSandboxConfigFile = v })
         (reqArgFlag "FILE")

U-CIQDEV\gbazerman's avatar
U-CIQDEV\gbazerman committed
297 298
      ,option [] ["default-user-config"]
         "Set a location for a cabal.config file for projects without their own cabal.config freeze file."
U-CIQDEV\gbazerman's avatar
U-CIQDEV\gbazerman committed
299 300 301
         globalConfigFile (\v flags -> flags {globalConstraintsFile = v})
         (reqArgFlag "FILE")

302
      ,option [] ["require-sandbox"]
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
303
         "requiring the presence of a sandbox for sandbox-aware commands"
304 305 306
         globalRequireSandbox (\v flags -> flags { globalRequireSandbox = v })
         (boolOpt' ([], ["require-sandbox"]) ([], ["no-require-sandbox"]))

307 308 309 310 311
      ,option [] ["ignore-sandbox"]
         "Ignore any existing sandbox"
         globalIgnoreSandbox (\v flags -> flags { globalIgnoreSandbox = v })
         trueArg

312
      ,option [] ["http-transport"]
313
         "Set a transport for http(s) requests. Accepts 'curl', 'wget', 'powershell', and 'plain-http'. (default: 'curl')"
314 315
         globalConfigFile (\v flags -> flags { globalHttpTransport = v })
         (reqArgFlag "HttpTransport")
316
      ]
317

318 319 320 321
    -- arguments we don't want shown in the help
    argsNotShown :: [OptionField GlobalFlags]
    argsNotShown = [
       option [] ["remote-repo"]
322 323
         "The name and url for a remote repository"
         globalRemoteRepos (\v flags -> flags { globalRemoteRepos = v })
324
         (reqArg' "NAME:URL" (toNubList . maybeToList . readRepo) (map showRepo . fromNubList))
325 326 327 328 329 330 331 332 333

      ,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 })
334
         (reqArg' "DIR" (\x -> toNubList [x]) fromNubList)
335

336 337 338 339 340
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

341 342 343 344
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
345 346 347 348
      ]

instance Monoid GlobalFlags where
  mempty = GlobalFlags {
349 350 351 352
    globalVersion           = mempty,
    globalNumericVersion    = mempty,
    globalConfigFile        = mempty,
    globalSandboxConfigFile = mempty,
U-CIQDEV\gbazerman's avatar
U-CIQDEV\gbazerman committed
353
    globalConstraintsFile   = mempty,
354 355 356 357
    globalRemoteRepos       = mempty,
    globalCacheDir          = mempty,
    globalLocalRepos        = mempty,
    globalLogsDir           = mempty,
358
    globalWorldFile         = mempty,
359
    globalRequireSandbox    = mempty,
360 361
    globalIgnoreSandbox     = mempty,
    globalHttpTransport     = mempty
362 363
  }
  mappend a b = GlobalFlags {
364 365 366 367
    globalVersion           = combine globalVersion,
    globalNumericVersion    = combine globalNumericVersion,
    globalConfigFile        = combine globalConfigFile,
    globalSandboxConfigFile = combine globalConfigFile,
U-CIQDEV\gbazerman's avatar
U-CIQDEV\gbazerman committed
368
    globalConstraintsFile   = combine globalConstraintsFile,
369 370 371 372
    globalRemoteRepos       = combine globalRemoteRepos,
    globalCacheDir          = combine globalCacheDir,
    globalLocalRepos        = combine globalLocalRepos,
    globalLogsDir           = combine globalLogsDir,
373
    globalWorldFile         = combine globalWorldFile,
374
    globalRequireSandbox    = combine globalRequireSandbox,
375 376
    globalIgnoreSandbox     = combine globalIgnoreSandbox,
    globalHttpTransport     = combine globalHttpTransport
Duncan Coutts's avatar
Duncan Coutts committed
377
  }
378 379 380 381 382 383
    where combine field = field a `mappend` field b

globalRepos :: GlobalFlags -> [Repo]
globalRepos globalFlags = remoteRepos ++ localRepos
  where
    remoteRepos =
Edsko de Vries's avatar
Edsko de Vries committed
384
      [ RepoRemote remote cacheDir
385
      | remote <- fromNubList $ globalRemoteRepos globalFlags
386 387 388
      , let cacheDir = fromFlag (globalCacheDir globalFlags)
                   </> remoteRepoName remote ]
    localRepos =
Edsko de Vries's avatar
Edsko de Vries committed
389
      [ RepoLocal local
390
      | local <- fromNubList $ globalLocalRepos globalFlags ]
391 392 393 394

-- ------------------------------------------------------------
-- * Config flags
-- ------------------------------------------------------------
Duncan Coutts's avatar
Duncan Coutts committed
395

396
configureCommand :: CommandUI ConfigFlags
397 398
configureCommand = c
  { commandDefaultFlags = mempty
399 400 401
  , commandNotes = Just $ \pname -> (case commandNotes c of
         Nothing -> ""
         Just n  -> n pname ++ "\n")
402 403 404 405 406 407
       ++ "Examples:\n"
       ++ "  " ++ pname ++ " configure\n"
       ++ "    Configure with defaults;\n"
       ++ "  " ++ pname ++ " configure --enable-tests -fcustomflag\n"
       ++ "    Configure building package including tests,\n"
       ++ "    with some package-specific flag.\n"
Duncan Coutts's avatar
Duncan Coutts committed
408
  }
409 410
 where
  c = Cabal.configureCommand defaultProgramConfiguration
Duncan Coutts's avatar
Duncan Coutts committed
411

412 413 414
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

415
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
416
filterConfigureFlags flags cabalLibVersion
417
  | cabalLibVersion >= Version [1,23,0] [] = flags_latest
418
  -- ^ NB: we expect the latest version to be the most common case.
419 420 421
  | cabalLibVersion <  Version [1,3,10] [] = flags_1_3_10
  | cabalLibVersion <  Version [1,10,0] [] = flags_1_10_0
  | cabalLibVersion <  Version [1,14,0] [] = flags_1_14_0
422
  | cabalLibVersion <  Version [1,18,0] [] = flags_1_18_0
423
  | cabalLibVersion <  Version [1,19,1] [] = flags_1_19_0
424
  | cabalLibVersion <  Version [1,19,2] [] = flags_1_19_1
425
  | cabalLibVersion <  Version [1,21,1] [] = flags_1_20_0
426
  | cabalLibVersion <  Version [1,22,0] [] = flags_1_21_0
427
  | cabalLibVersion <  Version [1,23,0] [] = flags_1_22_0
428
  | otherwise = flags_latest
429
  where
430
    -- Cabal >= 1.19.1 uses '--dependency' and does not need '--constraint'.
431 432
    flags_latest = flags        { configConstraints = [] }

433 434
    -- Cabal < 1.23 doesn't know about '--profiling-detail'.
    flags_1_22_0 = flags_latest { configProfDetail    = NoFlag
435 436
                                , configProfLibDetail = NoFlag
                                , configIPID          = NoFlag }
437

438
    -- Cabal < 1.22 doesn't know about '--disable-debug-info'.
439
    flags_1_21_0 = flags_1_22_0 { configDebugInfo = NoFlag }
440

441
    -- Cabal < 1.21.1 doesn't know about 'disable-relocatable'
442 443
    -- Cabal < 1.21.1 doesn't know about 'enable-profiling'
    flags_1_20_0 =
444
      flags_1_21_0 { configRelocatable = NoFlag
445 446 447 448
                   , configProf = NoFlag
                   , configProfExe = configProf flags
                   , configProfLib =
                     mappend (configProf flags) (configProfLib flags)
449 450
                   , configCoverage = NoFlag
                   , configLibCoverage = configCoverage flags
451
                   }
452 453 454 455
    -- Cabal < 1.19.2 doesn't know about '--exact-configuration' and
    -- '--enable-library-stripping'.
    flags_1_19_1 = flags_1_20_0 { configExactConfiguration = NoFlag
                                , configStripLibs = NoFlag }
456 457 458
    -- Cabal < 1.19.1 uses '--constraint' instead of '--dependency'.
    flags_1_19_0 = flags_1_19_1 { configDependencies = []
                                , configConstraints  = configConstraints flags }
459
    -- Cabal < 1.18.0 doesn't know about --extra-prog-path and --sysconfdir.
460
    flags_1_18_0 = flags_1_19_0 { configProgramPathExtra = toNubList []
461 462
                                , configInstallDirs = configInstallDirs_1_18_0}
    configInstallDirs_1_18_0 = (configInstallDirs flags) { sysconfdir = NoFlag }
463
    -- Cabal < 1.14.0 doesn't know about '--disable-benchmarks'.
464
    flags_1_14_0 = flags_1_18_0 { configBenchmarks  = NoFlag }
465
    -- Cabal < 1.10.0 doesn't know about '--disable-tests'.
466
    flags_1_10_0 = flags_1_14_0 { configTests       = NoFlag }
467
    -- Cabal < 1.3.10 does not grok the '--constraints' flag.
468
    flags_1_3_10 = flags_1_10_0 { configConstraints = [] }
469

470 471 472 473 474 475 476 477
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
478
    configExConstraints:: [(UserConstraint, ConstraintSource)],
479
    configPreferences  :: [Dependency],
480 481
    configSolver       :: Flag PreSolver,
    configAllowNewer   :: Flag AllowNewer
482 483 484
  }

defaultConfigExFlags :: ConfigExFlags
485 486
defaultConfigExFlags = mempty { configSolver     = Flag defaultSolver
                              , configAllowNewer = Flag AllowNewerNone }
487 488 489 490 491

configureExCommand :: CommandUI (ConfigFlags, ConfigExFlags)
configureExCommand = configureCommand {
    commandDefaultFlags = (mempty, defaultConfigExFlags),
    commandOptions      = \showOrParseArgs ->
492
         liftOptions fst setFst
493
         (filter ((`notElem` ["constraint", "dependency", "exact-configuration"])
494
                  . optionName) $ configureOptions  showOrParseArgs)
495 496
      ++ liftOptions snd setSnd
         (configureExOptions showOrParseArgs ConstraintSourceCommandlineFlag)
497 498 499 500 501
  }
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

502 503 504 505
configureExOptions :: ShowOrParseArgs
                   -> ConstraintSource
                   -> [OptionField ConfigExFlags]
configureExOptions _showOrParseArgs src =
506 507 508 509 510 511 512
  [ 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))
513 514 515 516
  , option [] ["constraint"]
      "Specify constraints on a package (version, installed/source, flags)"
      configExConstraints (\v flags -> flags { configExConstraints = v })
      (reqArg "CONSTRAINT"
517 518
              ((\x -> [(x, src)]) `fmap` ReadE readUserConstraint)
              (map $ display . fst))
519 520 521 522

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
523 524 525 526
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
527 528

  , optionSolver configSolver (\v flags -> flags { configSolver = v })
529 530

  , option [] ["allow-newer"]
cheecheeo's avatar
cheecheeo committed
531
    ("Ignore upper bounds in all dependencies or " ++ allowNewerArgument)
532
    configAllowNewer (\v flags -> flags { configAllowNewer = v})
cheecheeo's avatar
cheecheeo committed
533
    (optArg allowNewerArgument
534 535 536
     (fmap Flag allowNewerParser) (Flag AllowNewerAll)
     allowNewerPrinter)

537
  ]
cheecheeo's avatar
cheecheeo committed
538
  where allowNewerArgument = "DEPS"
539 540 541 542

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
543
    configExConstraints= mempty,
544
    configPreferences  = mempty,
545 546
    configSolver       = mempty,
    configAllowNewer   = mempty
547 548 549
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
550
    configExConstraints= combine configExConstraints,
551
    configPreferences  = combine configPreferences,
552 553
    configSolver       = combine configSolver,
    configAllowNewer   = combine configAllowNewer
554 555 556
  }
    where combine field = field a `mappend` field b

ttuegel's avatar
ttuegel committed
557 558 559 560
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

561 562 563 564 565 566 567 568 569 570
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
}

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

  : []

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

    parent = Cabal.buildCommand defaultProgramConfiguration

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

-- ------------------------------------------------------------
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
-- * Repl command
-- ------------------------------------------------------------

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

    parent = Cabal.replCommand defaultProgramConfiguration

621 622 623 624
-- ------------------------------------------------------------
-- * Test command
-- ------------------------------------------------------------

625
testCommand :: CommandUI (TestFlags, BuildFlags, BuildExFlags)
626
testCommand = parent {
627 628
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
629
  commandOptions      =
630
    \showOrParseArgs -> liftOptions get1 set1
631 632
                        (commandOptions parent showOrParseArgs)
                        ++
633 634 635 636
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
637 638
  }
  where
639 640 641
    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)
642

643 644
    parent   = Cabal.testCommand
    progConf = defaultProgramConfiguration
645 646 647 648 649

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

650
benchmarkCommand :: CommandUI (BenchmarkFlags, BuildFlags, BuildExFlags)
651
benchmarkCommand = parent {
652 653
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
654
  commandOptions      =
655
    \showOrParseArgs -> liftOptions get1 set1
656 657
                        (commandOptions parent showOrParseArgs)
                        ++
658 659 660 661
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
ttuegel's avatar
ttuegel committed
662
  }
663
  where
664 665 666
    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)
667

668 669
    parent   = Cabal.benchmarkCommand
    progConf = defaultProgramConfiguration
ttuegel's avatar
ttuegel committed
670

671
-- ------------------------------------------------------------
672
-- * Fetch command
673
-- ------------------------------------------------------------
674

675 676 677 678
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
679
      fetchSolver           :: Flag PreSolver,
680 681 682
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
683
      fetchShadowPkgs       :: Flag Bool,
Andres Löh's avatar
Andres Löh committed
684
      fetchStrongFlags      :: Flag Bool,
685 686 687 688 689 690 691 692
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
693 694
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
695
    fetchReorderGoals     = Flag False,
696
    fetchIndependentGoals = Flag False,
697
    fetchShadowPkgs       = Flag False,
Andres Löh's avatar
Andres Löh committed
698
    fetchStrongFlags      = Flag False,
699 700 701 702
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
703 704
fetchCommand = CommandUI {
    commandName         = "fetch",
705
    commandSynopsis     = "Downloads packages for later installation.",
706 707 708 709 710
    commandUsage        = usageAlternatives "fetch" [ "[FLAGS] PACKAGES"
                                                    ],
    commandDescription  = Just $ \_ ->
          "Note that it currently is not possible to fetch the dependencies for a\n"
       ++ "package in the current directory.\n",
711
    commandNotes        = Nothing,
712
    commandDefaultFlags = defaultFetchFlags,
713
    commandOptions      = \ showOrParseArgs -> [
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
         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
735 736 737 738

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
739 740
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
741 742
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
743
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
Andres Löh's avatar
Andres Löh committed
744
                         fetchStrongFlags      (\v flags -> flags { fetchStrongFlags      = v })
745

Duncan Coutts's avatar
Duncan Coutts committed
746 747
  }

748 749 750 751 752 753
-- ------------------------------------------------------------
-- * Freeze command
-- ------------------------------------------------------------

data FreezeFlags = FreezeFlags {
      freezeDryRun           :: Flag Bool,
754 755
      freezeTests            :: Flag Bool,
      freezeBenchmarks       :: Flag Bool,
756 757 758 759 760
      freezeSolver           :: Flag PreSolver,
      freezeMaxBackjumps     :: Flag Int,
      freezeReorderGoals     :: Flag Bool,
      freezeIndependentGoals :: Flag Bool,
      freezeShadowPkgs       :: Flag Bool,
Andres Löh's avatar
Andres Löh committed
761
      freezeStrongFlags      :: Flag Bool,
762 763 764 765 766 767
      freezeVerbosity        :: Flag Verbosity
    }

defaultFreezeFlags :: FreezeFlags
defaultFreezeFlags = FreezeFlags {
    freezeDryRun           = toFlag False,
768 769
    freezeTests            = toFlag False,
    freezeBenchmarks       = toFlag False,
770 771
    freezeSolver           = Flag defaultSolver,
    freezeMaxBackjumps     = Flag defaultMaxBackjumps,
772
    freezeReorderGoals     = Flag False,
773 774
    freezeIndependentGoals = Flag False,
    freezeShadowPkgs       = Flag False,
Andres Löh's avatar
Andres Löh committed
775
    freezeStrongFlags      = Flag False,
776 777 778 779 780 781 782
    freezeVerbosity        = toFlag normal
   }

freezeCommand :: CommandUI FreezeFlags
freezeCommand = CommandUI {
    commandName         = "freeze",
    commandSynopsis     = "Freeze dependencies.",
783 784 785 786 787 788 789 790
    commandDescription  = Just $ \_ -> wrapText $
         "Calculates a valid set of dependencies and their exact versions. "
      ++ "If successful, saves the result to the file `cabal.config`.\n"
      ++ "\n"
      ++ "The package versions specified in `cabal.config` will be used for "
      ++ "any future installs.\n"
      ++ "\n"
      ++ "An existing `cabal.config` is ignored and overwritten.\n",
791
    commandNotes        = Nothing,
792
    commandUsage        = usageFlags "freeze",
793 794 795 796 797 798 799 800 801
    commandDefaultFlags = defaultFreezeFlags,
    commandOptions      = \ showOrParseArgs -> [
         optionVerbosity freezeVerbosity (\v flags -> flags { freezeVerbosity = v })

       , option [] ["dry-run"]
           "Do not freeze anything, only print what would be frozen"
           freezeDryRun (\v flags -> flags { freezeDryRun = v })
           trueArg

802 803 804 805 806 807 808 809 810 811
       , option [] ["tests"]
           "freezing of the dependencies of any tests suites in the package description file."
           freezeTests (\v flags -> flags { freezeTests = v })
           (boolOpt [] [])

       , option [] ["benchmarks"]
           "freezing of the dependencies of any benchmarks suites in the package description file."
           freezeBenchmarks (\v flags -> flags { freezeBenchmarks = v })
           (boolOpt [] [])

812 813 814 815 816 817 818 819
       ] ++

       optionSolver      freezeSolver           (\v flags -> flags { freezeSolver           = v }) :
       optionSolverFlags showOrParseArgs
                         freezeMaxBackjumps     (\v flags -> flags { freezeMaxBackjumps     = v })
                         freezeReorderGoals     (\v flags -> flags { freezeReorderGoals     = v })
                         freezeIndependentGoals (\v flags -> flags { freezeIndependentGoals = v })
                         freezeShadowPkgs       (\v flags -> flags { freezeShadowPkgs       = v })
Andres Löh's avatar
Andres Löh committed
820
                         freezeStrongFlags      (\v flags -> flags { freezeStrongFlags      = v })
821 822 823

  }

824 825 826 827
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

828
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
829 830
updateCommand = CommandUI {
    commandName         = "update",
831
    commandSynopsis     = "Updates list of known packages.",
832 833 834
    commandDescription  = Just $ \_ ->
      "For all known remote repositories, download the package list.\n",
    commandNotes        = Just $ \_ ->
835 836 837
      relevantConfigValuesText ["remote-repo"
                               ,"remote-repo-cache"
                               ,"local-repo"],
refold's avatar
refold committed
838
    commandUsage        = usageFlags "update",
839
    commandDefaultFlags = toFlag normal,
840
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
841 842
  }

843
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
844
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
845
    commandName         = "upgrade",
846
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
847
    commandDescription  = Nothing,
refold's avatar
refold committed
848
    commandUsage        = usageFlagsOrPackages "upgrade",
849
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
850
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
851 852
  }

Duncan Coutts's avatar
Duncan Coutts committed
853 854 855 856 857 858 859 860 861 862 863
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

864 865 866
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
867
    commandSynopsis     = "Check the package for common mistakes.",
868 869 870 871 872 873
    commandDescription  = Just $ \_ -> wrapText $
         "Expects a .cabal package file in the current directory.\n"
      ++ "\n"
      ++ "The checks correspond to the requirements to packages on Hackage. "
      ++ "If no errors and warnings are reported, Hackage will accept this "
      ++ "package.\n",
874
    commandNotes        = Nothing,
875
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
876
    commandDefaultFlags = toFlag normal,
877
    commandOptions      = \_ -> []
878 879
  }

880 881 882 883 884
formatCommand  :: CommandUI (Flag Verbosity)
formatCommand = CommandUI {
    commandName         = "format",
    commandSynopsis     = "Reformat the .cabal file using the standard style.",
    commandDescription  = Nothing,
885
    commandNotes        = Nothing,
886
    commandUsage        = usageAlternatives "format" ["[FILE]"],
887 888 889 890
    commandDefaultFlags = toFlag normal,
    commandOptions      = \_ -> []
  }

891 892 893 894 895 896 897 898 899 900 901
uninstallCommand  :: CommandUI (Flag Verbosity)
uninstallCommand = CommandUI {
    commandName         = "uninstall",
    commandSynopsis     = "Warn about 'uninstall' not being implemented.",
    commandDescription  = Nothing,
    commandNotes        = Nothing,
    commandUsage        = usageAlternatives "uninstall" ["PACKAGES"],
    commandDefaultFlags = toFlag normal,
    commandOptions      = \_ -> []
  }

Maciek Makowski's avatar
Maciek Makowski committed
902 903 904 905 906 907 908 909 910 911 912 913
manpageCommand :: CommandUI (Flag Verbosity)
manpageCommand = CommandUI {
    commandName         = "manpage",
    commandSynopsis     = "Outputs manpage source.",
    commandDescription  = Just $ \_ ->
      "Output manpage source to STDOUT.\n",
    commandNotes        = Nothing,
    commandUsage        = usageFlags "manpage",
    commandDefaultFlags = toFlag normal,
    commandOptions      = \_ -> [optionVerbosity id const]
  }

914
runCommand :: CommandUI (BuildFlags, BuildExFlags)
refold's avatar
refold committed
915 916
runCommand = CommandUI {
    commandName         = "run",
917
    commandSynopsis     = "Builds and runs an executable.",
918
    commandDescription  = Just $ \pname -> wrapText $
919 920
         "Builds and then runs the specified executable. If no executable is "
      ++ "specified, but the package contains just one executable, that one "
921 922 923 924
      ++ "is built and executed.\n"
      ++ "\n"
      ++ "Use `" ++ pname ++ " test --show-details=streaming` to run a "
      ++ "test-suite and get its full output.\n",