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

    , parsePackageArgs
52 53 54
    --TODO: stop exporting these:
    , showRepo
    , parseRepo
55
    , readRepo
56 57
    ) where

58 59 60
import Prelude ()
import Distribution.Client.Compat.Prelude hiding (get)

61
import Distribution.Client.Types
62
         ( Username(..), Password(..), RemoteRepo(..) )
63 64
import Distribution.Client.BuildReports.Types
         ( ReportLevel(..) )
65
import Distribution.Client.Dependency.Types
66
         ( PreSolver(..) )
67 68 69 70

import Distribution.Client.IndexUtils.Timestamp
         ( IndexState )

71 72
import qualified Distribution.Client.Init.Types as IT
         ( InitFlags(..), PackageType(..) )
73 74
import Distribution.Client.Targets
         ( UserConstraint, readUserConstraint )
75 76
import Distribution.Utils.NubList
         ( NubList, toNubList, fromNubList)
77

78
import Distribution.Solver.Types.ConstraintSource
79
import Distribution.Solver.Types.Settings
80

81 82
import Distribution.Simple.Compiler ( Compiler, PackageDB, PackageDBStack )
import Distribution.Simple.Program (ProgramDb, defaultProgramDb)
83 84
import Distribution.Simple.Command hiding (boolOpt, boolOpt')
import qualified Distribution.Simple.Command as Command
85
import Distribution.Simple.Configure
86
       ( configCompilerAuxEx, interpretPackageDbFlags, computeEffectiveProfiling )
Duncan Coutts's avatar
Duncan Coutts committed
87
import qualified Distribution.Simple.Setup as Cabal
88
import Distribution.Simple.Setup
89 90
         ( ConfigFlags(..), BuildFlags(..), ReplFlags
         , TestFlags(..), BenchmarkFlags(..)
91
         , SDistFlags(..), HaddockFlags(..)
92
         , readPackageDbList, showPackageDbList
Edsko de Vries's avatar
Edsko de Vries committed
93
         , Flag(..), toFlag, flagToMaybe, flagToList
94 95
         , BooleanFlag(..), optionVerbosity
         , boolOpt, boolOpt', trueArg, falseArg
96
         , optionNumJobs )
97
import Distribution.Simple.InstallDirs
Christiaan Baaij's avatar
Christiaan Baaij committed
98
         ( PathTemplate, InstallDirs(dynlibdir, sysconfdir)
99
         , toPathTemplate, fromPathTemplate )
100
import Distribution.Version
101
         ( Version, mkVersion, nullVersion, anyVersion, thisVersion )
102
import Distribution.Package
103 104
         ( PackageIdentifier, packageName, packageVersion )
import Distribution.Types.Dependency
105
import Distribution.PackageDescription
106
         ( BuildType(..), RepoKind(..) )
107
import Distribution.System ( Platform )
108
import Distribution.Text
109
         ( Text(..), display )
110
import Distribution.ReadE
111
         ( ReadE(..), readP_to_E, succeedReadE )
112
import qualified Distribution.Compat.ReadP as Parse
113
         ( ReadP, char, munch1, pfail,  (+++) )
114 115
import Distribution.ParseUtils
         ( readPToMaybe )
116
import Distribution.Verbosity
117
         ( Verbosity, lessVerbose, normal )
118
import Distribution.Simple.Utils
119
         ( wrapText, wrapLine )
120
import Distribution.Client.GlobalFlags
Edsko de Vries's avatar
Edsko de Vries committed
121 122 123
         ( GlobalFlags(..), defaultGlobalFlags
         , RepoContext(..), withRepoContext
         )
124

125
import Data.List
126
         ( deleteFirstsBy )
127 128 129 130
import System.FilePath
         ( (</>) )
import Network.URI
         ( parseAbsoluteURI, uriToString )
131

132 133
globalCommand :: [Command action] -> CommandUI GlobalFlags
globalCommand commands = CommandUI {
134
    commandName         = "",
135 136
    commandSynopsis     =
         "Command line interface to the Haskell Cabal infrastructure.",
137 138 139 140
    commandUsage        = \pname ->
         "See http://www.haskell.org/cabal/ for more information.\n"
      ++ "\n"
      ++ "Usage: " ++ pname ++ " [GLOBAL FLAGS] [COMMAND [FLAGS]]\n",
141
    commandDescription  = Just $ \pname ->
142 143 144
      let
        commands' = commands ++ [commandAddAction helpCommandUI undefined]
        cmdDescs = getNormalCommandDescriptions commands'
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
        -- 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"
173
          , "gen-bounds"
174 175 176 177 178 179 180
          , "haddock"
          , "hscolour"
          , "copy"
          , "register"
          , "sandbox"
          , "exec"
          ]
181 182
        maxlen    = maximum $ [length name | (name, _) <- cmdDescs]
        align str = str ++ replicate (maxlen - length str) ' '
183 184 185 186 187 188 189 190 191
        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
192 193
      in
         "Commands:\n"
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
      ++ 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"
224
        , addCmd "gen-bounds"
225 226 227 228 229 230
        , addCmd "haddock"
        , addCmd "hscolour"
        , addCmd "copy"
        , addCmd "register"
        , par
        , startGroup "sandbox"
231
        , addCmd "sandbox"
232 233 234 235 236
        , addCmd "exec"
        , addCmdCustom "repl" "Open interpreter with access to sandbox packages."
        ] ++ if null otherCmds then [] else par
                                           :startGroup "other"
                                           :[addCmd n | n <- otherCmds])
237 238
      ++ "\n"
      ++ "For more information about a command use:\n"
239 240
      ++ "   " ++ pname ++ " COMMAND --help\n"
      ++ "or " ++ pname ++ " help COMMAND\n"
241
      ++ "\n"
242
      ++ "To install Cabal packages from hackage use:\n"
243 244
      ++ "  " ++ pname ++ " install foo [--dry-run]\n"
      ++ "\n"
245 246
      ++ "Occasionally you need to update the list of available packages:\n"
      ++ "  " ++ pname ++ " update\n",
247
    commandNotes = Nothing,
248
    commandDefaultFlags = mempty,
249 250 251 252 253 254 255 256 257 258 259
    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"]
260 261 262 263 264 265 266 267 268 269 270 271 272 273
         "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")

274
      ,option [] ["sandbox-config-file"]
275
         "Set an alternate location for the sandbox config file (default: './cabal.sandbox.config')"
276
         globalSandboxConfigFile (\v flags -> flags { globalSandboxConfigFile = v })
277 278
         (reqArgFlag "FILE")

U-CIQDEV\gbazerman's avatar
U-CIQDEV\gbazerman committed
279 280
      ,option [] ["default-user-config"]
         "Set a location for a cabal.config file for projects without their own cabal.config freeze file."
281
         globalConstraintsFile (\v flags -> flags {globalConstraintsFile = v})
U-CIQDEV\gbazerman's avatar
U-CIQDEV\gbazerman committed
282 283
         (reqArgFlag "FILE")

284
      ,option [] ["require-sandbox"]
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
285
         "requiring the presence of a sandbox for sandbox-aware commands"
286 287 288
         globalRequireSandbox (\v flags -> flags { globalRequireSandbox = v })
         (boolOpt' ([], ["require-sandbox"]) ([], ["no-require-sandbox"]))

289 290 291 292 293
      ,option [] ["ignore-sandbox"]
         "Ignore any existing sandbox"
         globalIgnoreSandbox (\v flags -> flags { globalIgnoreSandbox = v })
         trueArg

294
      ,option [] ["ignore-expiry"]
Edsko de Vries's avatar
Edsko de Vries committed
295
         "Ignore expiry dates on signed metadata (use only in exceptional circumstances)"
296 297 298
         globalIgnoreExpiry (\v flags -> flags { globalIgnoreExpiry = v })
         trueArg

299
      ,option [] ["http-transport"]
300
         "Set a transport for http(s) requests. Accepts 'curl', 'wget', 'powershell', and 'plain-http'. (default: 'curl')"
301
         globalHttpTransport (\v flags -> flags { globalHttpTransport = v })
302
         (reqArgFlag "HttpTransport")
ttuegel's avatar
ttuegel committed
303 304 305 306
      ,option [] ["nix"]
         "Nix integration: run commands through nix-shell if a 'shell.nix' file exists"
         globalNix (\v flags -> flags { globalNix = v })
         (boolOpt [] [])
307
      ]
308

309 310 311 312
    -- arguments we don't want shown in the help
    argsNotShown :: [OptionField GlobalFlags]
    argsNotShown = [
       option [] ["remote-repo"]
313 314
         "The name and url for a remote repository"
         globalRemoteRepos (\v flags -> flags { globalRemoteRepos = v })
315
         (reqArg' "NAME:URL" (toNubList . maybeToList . readRepo) (map showRepo . fromNubList))
316 317 318 319 320 321 322 323 324

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

327 328 329 330 331
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

332 333 334 335
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
336 337 338 339 340
      ]

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

342
configureCommand :: CommandUI ConfigFlags
343 344
configureCommand = c
  { commandDefaultFlags = mempty
345 346 347
  , commandNotes = Just $ \pname -> (case commandNotes c of
         Nothing -> ""
         Just n  -> n pname ++ "\n")
348 349 350 351 352 353
       ++ "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
354
  }
355
 where
356
  c = Cabal.configureCommand defaultProgramDb
Duncan Coutts's avatar
Duncan Coutts committed
357

358 359 360
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

361 362 363 364 365 366 367 368
-- | Given some 'ConfigFlags' for the version of Cabal that
-- cabal-install was built with, and a target older 'Version' of
-- Cabal that we want to pass these flags to, convert the
-- flags into a form that will be accepted by the older
-- Setup script.  Generally speaking, this just means filtering
-- out flags that the old Cabal library doesn't understand, but
-- in some cases it may also mean "emulating" a feature using
-- some more legacy flags.
369
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
370
filterConfigureFlags flags cabalLibVersion
371 372
  -- NB: we expect the latest version to be the most common case,
  -- so test it first.
Christiaan Baaij's avatar
Christiaan Baaij committed
373
  | cabalLibVersion >= mkVersion [1,25,0] = flags_latest
374 375 376 377 378
  -- The naming convention is that flags_version gives flags with
  -- all flags *introduced* in version eliminated.
  -- It is NOT the latest version of Cabal library that
  -- these flags work for; version of introduction is a more
  -- natural metric.
379 380 381 382 383 384 385 386 387 388
  | cabalLibVersion < mkVersion [1,3,10] = flags_1_3_10
  | cabalLibVersion < mkVersion [1,10,0] = flags_1_10_0
  | cabalLibVersion < mkVersion [1,12,0] = flags_1_12_0
  | cabalLibVersion < mkVersion [1,14,0] = flags_1_14_0
  | cabalLibVersion < mkVersion [1,18,0] = flags_1_18_0
  | cabalLibVersion < mkVersion [1,19,1] = flags_1_19_1
  | cabalLibVersion < mkVersion [1,19,2] = flags_1_19_2
  | cabalLibVersion < mkVersion [1,21,1] = flags_1_21_1
  | cabalLibVersion < mkVersion [1,22,0] = flags_1_22_0
  | cabalLibVersion < mkVersion [1,23,0] = flags_1_23_0
Christiaan Baaij's avatar
Christiaan Baaij committed
389
  | cabalLibVersion < mkVersion [1,25,0] = flags_1_25_0
390
  | otherwise = flags_latest
391
  where
392 393 394
    flags_latest = flags        {
      -- Cabal >= 1.19.1 uses '--dependency' and does not need '--constraint'.
      configConstraints = [],
395
      -- Passing '--allow-{older,newer}' to Setup.hs is unnecessary, we use
396
      -- '--exact-configuration' instead.
397
      configAllowOlder  = Just (Cabal.AllowOlder Cabal.RelaxDepsNone),
398
      configAllowNewer  = Just (Cabal.AllowNewer Cabal.RelaxDepsNone)
399
      }
400

Christiaan Baaij's avatar
Christiaan Baaij committed
401 402 403 404
    -- Cabal < 1.25.0 doesn't know about --dynlibdir.
    flags_1_25_0 = flags_latest { configInstallDirs = configInstallDirs_1_25_0}
    configInstallDirs_1_25_0 = (configInstallDirs flags) { dynlibdir = NoFlag }

405
    -- Cabal < 1.23 doesn't know about '--profiling-detail'.
406 407 408
    -- Cabal < 1.23 has a hacked up version of 'enable-profiling'
    -- which we shouldn't use.
    (tryLibProfiling, tryExeProfiling) = computeEffectiveProfiling flags
Christiaan Baaij's avatar
Christiaan Baaij committed
409
    flags_1_23_0 = flags_1_25_0 { configProfDetail    = NoFlag
410
                                , configProfLibDetail = NoFlag
411
                                , configIPID          = NoFlag
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
412 413 414
                                , configProf          = NoFlag
                                , configProfExe       = Flag tryExeProfiling
                                , configProfLib       = Flag tryLibProfiling
415
                                }
416

417
    -- Cabal < 1.22 doesn't know about '--disable-debug-info'.
418
    flags_1_22_0 = flags_1_23_0 { configDebugInfo = NoFlag }
419

420
    -- Cabal < 1.21.1 doesn't know about 'disable-relocatable'
421
    -- Cabal < 1.21.1 doesn't know about 'enable-profiling'
422
    -- (but we already dealt with it in flags_1_23_0)
423 424
    flags_1_21_1 =
      flags_1_22_0 { configRelocatable = NoFlag
425 426
                   , configCoverage = NoFlag
                   , configLibCoverage = configCoverage flags
427
                   }
428 429
    -- Cabal < 1.19.2 doesn't know about '--exact-configuration' and
    -- '--enable-library-stripping'.
430
    flags_1_19_2 = flags_1_21_1 { configExactConfiguration = NoFlag
431
                                , configStripLibs = NoFlag }
432
    -- Cabal < 1.19.1 uses '--constraint' instead of '--dependency'.
433
    flags_1_19_1 = flags_1_19_2 { configDependencies = []
434
                                , configConstraints  = configConstraints flags }
435
    -- Cabal < 1.18.0 doesn't know about --extra-prog-path and --sysconfdir.
436
    flags_1_18_0 = flags_1_19_1 { configProgramPathExtra = toNubList []
437
                                , configInstallDirs = configInstallDirs_1_18_0}
Christiaan Baaij's avatar
Christiaan Baaij committed
438
    configInstallDirs_1_18_0 = (configInstallDirs flags_1_19_1) { sysconfdir = NoFlag }
439
    -- Cabal < 1.14.0 doesn't know about '--disable-benchmarks'.
440
    flags_1_14_0 = flags_1_18_0 { configBenchmarks  = NoFlag }
441 442 443 444
    -- Cabal < 1.12.0 doesn't know about '--enable/disable-executable-dynamic'
    -- and '--enable/disable-library-coverage'.
    flags_1_12_0 = flags_1_14_0 { configLibCoverage = NoFlag
                                , configDynExe      = NoFlag }
445
    -- Cabal < 1.10.0 doesn't know about '--disable-tests'.
446
    flags_1_10_0 = flags_1_12_0 { configTests       = NoFlag }
447
    -- Cabal < 1.3.10 does not grok the '--constraints' flag.
448
    flags_1_3_10 = flags_1_10_0 { configConstraints = [] }
449

450 451
-- | Get the package database settings from 'ConfigFlags', accounting for
-- @--package-db@ and @--user@ flags.
452 453 454 455 456 457
configPackageDB' :: ConfigFlags -> PackageDBStack
configPackageDB' cfg =
    interpretPackageDbFlags userInstall (configPackageDBs cfg)
  where
    userInstall = Cabal.fromFlagOrDefault True (configUserInstall cfg)

458
-- | Configure the compiler, but reduce verbosity during this step.
459 460 461 462 463 464
configCompilerAux' :: ConfigFlags -> IO (Compiler, Platform, ProgramDb)
configCompilerAux' configFlags =
  configCompilerAuxEx configFlags
    --FIXME: make configCompilerAux use a sensible verbosity
    { configVerbosity = fmap lessVerbose (configVerbosity configFlags) }

465 466 467 468 469 470 471 472
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
473
    configExConstraints:: [(UserConstraint, ConstraintSource)],
474
    configPreferences  :: [Dependency],
475
    configSolver       :: Flag PreSolver
476
  }
477
  deriving (Eq, Generic)
478 479

defaultConfigExFlags :: ConfigExFlags
480
defaultConfigExFlags = mempty { configSolver     = Flag defaultSolver }
481 482 483 484 485

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

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

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
517 518 519 520
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
521 522

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

524 525 526
  ]

instance Monoid ConfigExFlags where
527
  mempty = gmempty
528 529 530
  mappend = (<>)

instance Semigroup ConfigExFlags where
531
  (<>) = gmappend
532

ttuegel's avatar
ttuegel committed
533 534 535 536 537 538
reconfigureCommand :: CommandUI (ConfigFlags, ConfigExFlags)
reconfigureCommand
  = configureExCommand
    { commandName         = "reconfigure"
    , commandSynopsis     = "Reconfigure the package if necessary."
    , commandDescription  = Just $ \pname -> wrapText $
539 540
         "Run `configure` with the most recently used flags, or append FLAGS "
         ++ "to the most recently used configuration. "
ttuegel's avatar
ttuegel committed
541
         ++ "Accepts the same flags as `" ++ pname ++ " configure'. "
542 543 544 545 546 547 548 549 550
         ++ "If the package has never been configured, the default flags are "
         ++ "used."
    , commandNotes        = Just $ \pname ->
        "Examples:\n"
        ++ "  " ++ pname ++ " reconfigure\n"
        ++ "    Configure with the most recently used flags.\n"
        ++ "  " ++ pname ++ " reconfigure -w PATH\n"
        ++ "    Reconfigure with the most recently used flags,\n"
        ++ "    but use the compiler at PATH.\n\n"
ttuegel's avatar
ttuegel committed
551 552 553 554
    , commandUsage        = usageAlternatives "reconfigure" [ "[FLAGS]" ]
    , commandDefaultFlags = mempty
    }

ttuegel's avatar
ttuegel committed
555 556 557 558
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

559 560 561 562 563 564
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
565
} deriving Generic
566 567 568

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
569
  option [] ["only"]
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
  "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)

589
    parent = Cabal.buildCommand defaultProgramDb
590 591

instance Monoid BuildExFlags where
592
  mempty = gmempty
593 594 595
  mappend = (<>)

instance Semigroup BuildExFlags where
596
  (<>) = gmappend
597 598

-- ------------------------------------------------------------
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
-- * 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)

615
    parent = Cabal.replCommand defaultProgramDb
616

617 618 619 620
-- ------------------------------------------------------------
-- * Test command
-- ------------------------------------------------------------

621
testCommand :: CommandUI (TestFlags, BuildFlags, BuildExFlags)
622
testCommand = parent {
623 624
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
625
  commandOptions      =
626
    \showOrParseArgs -> liftOptions get1 set1
627 628
                        (commandOptions parent showOrParseArgs)
                        ++
629
                        liftOptions get2 set2
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
630
                        (Cabal.buildOptions progDb showOrParseArgs)
631 632
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
633 634
  }
  where
635 636 637
    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)
638

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
639 640
    parent = Cabal.testCommand
    progDb = defaultProgramDb
641 642 643 644 645

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

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

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
664 665
    parent = Cabal.benchmarkCommand
    progDb = defaultProgramDb
ttuegel's avatar
ttuegel committed
666

667
-- ------------------------------------------------------------
668
-- * Fetch command
669
-- ------------------------------------------------------------
670

671 672 673 674
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
675
      fetchSolver           :: Flag PreSolver,
676
      fetchMaxBackjumps     :: Flag Int,
677
      fetchReorderGoals     :: Flag ReorderGoals,
678
      fetchCountConflicts   :: Flag CountConflicts,
679 680 681
      fetchIndependentGoals :: Flag IndependentGoals,
      fetchShadowPkgs       :: Flag ShadowPkgs,
      fetchStrongFlags      :: Flag StrongFlags,
682 683 684 685 686 687 688 689
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
690 691
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
692
    fetchReorderGoals     = Flag (ReorderGoals False),
693
    fetchCountConflicts   = Flag (CountConflicts True),
694 695 696
    fetchIndependentGoals = Flag (IndependentGoals False),
    fetchShadowPkgs       = Flag (ShadowPkgs False),
    fetchStrongFlags      = Flag (StrongFlags False),
697 698 699 700
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
701 702
fetchCommand = CommandUI {
    commandName         = "fetch",
703
    commandSynopsis     = "Downloads packages for later installation.",
704 705 706 707 708
    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",
709
    commandNotes        = Nothing,
710
    commandDefaultFlags = defaultFetchFlags,
711
    commandOptions      = \ showOrParseArgs -> [
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
         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
733 734 735 736

       ] ++

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

Duncan Coutts's avatar
Duncan Coutts committed
745 746
  }

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

data FreezeFlags = FreezeFlags {
      freezeDryRun           :: Flag Bool,
753 754
      freezeTests            :: Flag Bool,
      freezeBenchmarks       :: Flag Bool,
755 756
      freezeSolver           :: Flag PreSolver,
      freezeMaxBackjumps     :: Flag Int,
757
      freezeReorderGoals     :: Flag ReorderGoals,
758
      freezeCountConflicts   :: Flag CountConflicts,
759 760 761
      freezeIndependentGoals :: Flag IndependentGoals,
      freezeShadowPkgs       :: Flag ShadowPkgs,
      freezeStrongFlags      :: Flag StrongFlags,
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 (ReorderGoals False),
773
    freezeCountConflicts   = Flag (CountConflicts True),
774 775 776
    freezeIndependentGoals = Flag (IndependentGoals False),
    freezeShadowPkgs       = Flag (ShadowPkgs False),
    freezeStrongFlags      = Flag (StrongFlags False),
777 778 779 780 781 782 783
    freezeVerbosity        = toFlag normal
   }

freezeCommand :: CommandUI FreezeFlags
freezeCommand = CommandUI {
    commandName         = "freeze",
    commandSynopsis     = "Freeze dependencies.",
784 785 786 787 788 789 790 791
    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",
792
    commandNotes        = Nothing,
793
    commandUsage        = usageFlags "freeze",
794 795 796 797 798 799 800 801 802
    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

803 804 805 806 807 808 809 810 811 812
       , 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 [] [])

813 814 815 816 817 818
       ] ++

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

  }

826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
genBoundsCommand :: CommandUI FreezeFlags
genBoundsCommand = CommandUI {
    commandName         = "gen-bounds",
    commandSynopsis     = "Generate dependency bounds.",
    commandDescription  = Just $ \_ -> wrapText $
         "Generates bounds for all dependencies that do not currently have them. "
      ++ "Generated bounds are printed to stdout.  You can then paste them into your .cabal file.\n"
      ++ "\n",
    commandNotes        = Nothing,
    commandUsage        = usageFlags "gen-bounds",
    commandDefaultFlags = defaultFreezeFlags,
    commandOptions      = \ _ -> [
     optionVerbosity freezeVerbosity (\v flags -> flags { freezeVerbosity = v })
     ]
  }

842 843 844 845
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

846
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
847 848
updateCommand = CommandUI {
    commandName         = "update",
849
    commandSynopsis     = "Updates list of known packages.",
850 851 852
    commandDescription  = Just $ \_ ->
      "For all known remote repositories, download the package list.\n",
    commandNotes        = Just $ \_ ->
853 854 855
      relevantConfigValuesText ["remote-repo"
                               ,"remote-repo-cache"
                               ,"local-repo"],
refold's avatar
refold committed
856
    commandUsage        = usageFlags "update",
857
    commandDefaultFlags = toFlag normal,
858
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
859 860
  }

861
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
862
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
863
    commandName         = "upgrade",
864
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
865
    commandDescription  = Nothing,
refold's avatar
refold committed
866
    commandUsage        = usageFlagsOrPackages "upgrade",
867
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
868
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
869 870
  }

Duncan Coutts's avatar
Duncan Coutts committed
871 872 873 874 875 876 877 878 879 880 881
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

882 883 884
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
885
    commandSynopsis     = "Check the package for common mistakes.",
886 887 888 889 890 891
    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",
892
    commandNotes        = Nothing,
893
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
894
    commandDefaultFlags = toFlag normal,
895
    commandOptions      = \_ -> []
896 897
  }

898 899 900 901 902
formatCommand  :: CommandUI (Flag Verbosity)
formatCommand = CommandUI {
    commandName         = "format",
    commandSynopsis     = "Reformat the .cabal file using the standard style.",
    commandDescription  = Nothing,
903
    commandNotes        = Nothing,