Setup.hs 90.5 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
import Distribution.Client.Types
59
         ( Username(..), Password(..), RemoteRepo(..) )
60
61
import Distribution.Client.BuildReports.Types
         ( ReportLevel(..) )
62
import Distribution.Client.Dependency.Types
63
         ( PreSolver(..) )
64
65
66
67

import Distribution.Client.IndexUtils.Timestamp
         ( IndexState )

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

75
import Distribution.Solver.Types.ConstraintSource
76
import Distribution.Solver.Types.Settings
77

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

120
import Data.Char
121
         ( isAlphaNum )
122
import Data.List
123
         ( intercalate, deleteFirstsBy )
124
import Data.Maybe
125
         ( maybeToList, fromMaybe )
126
127
import GHC.Generics (Generic)
import Distribution.Compat.Binary (Binary)
128
129
130
131
132
133
import Control.Monad
         ( liftM )
import System.FilePath
         ( (</>) )
import Network.URI
         ( parseAbsoluteURI, uriToString )
134

135
136
globalCommand :: [Command action] -> CommandUI GlobalFlags
globalCommand commands = CommandUI {
137
    commandName         = "",
138
139
    commandSynopsis     =
         "Command line interface to the Haskell Cabal infrastructure.",
140
141
142
143
    commandUsage        = \pname ->
         "See http://www.haskell.org/cabal/ for more information.\n"
      ++ "\n"
      ++ "Usage: " ++ pname ++ " [GLOBAL FLAGS] [COMMAND [FLAGS]]\n",
144
    commandDescription  = Just $ \pname ->
145
146
147
      let
        commands' = commands ++ [commandAddAction helpCommandUI undefined]
        cmdDescs = getNormalCommandDescriptions commands'
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
173
174
175
        -- 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"
176
          , "gen-bounds"
177
178
179
180
181
182
183
          , "haddock"
          , "hscolour"
          , "copy"
          , "register"
          , "sandbox"
          , "exec"
          ]
184
185
        maxlen    = maximum $ [length name | (name, _) <- cmdDescs]
        align str = str ++ replicate (maxlen - length str) ' '
186
187
188
189
190
191
192
193
194
        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
195
196
      in
         "Commands:\n"
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
224
225
226
      ++ 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"
227
        , addCmd "gen-bounds"
228
229
230
231
232
233
        , addCmd "haddock"
        , addCmd "hscolour"
        , addCmd "copy"
        , addCmd "register"
        , par
        , startGroup "sandbox"
234
        , addCmd "sandbox"
235
236
237
238
239
        , addCmd "exec"
        , addCmdCustom "repl" "Open interpreter with access to sandbox packages."
        ] ++ if null otherCmds then [] else par
                                           :startGroup "other"
                                           :[addCmd n | n <- otherCmds])
240
241
      ++ "\n"
      ++ "For more information about a command use:\n"
242
243
      ++ "   " ++ pname ++ " COMMAND --help\n"
      ++ "or " ++ pname ++ " help COMMAND\n"
244
      ++ "\n"
245
      ++ "To install Cabal packages from hackage use:\n"
246
247
      ++ "  " ++ pname ++ " install foo [--dry-run]\n"
      ++ "\n"
248
249
      ++ "Occasionally you need to update the list of available packages:\n"
      ++ "  " ++ pname ++ " update\n",
250
    commandNotes = Nothing,
251
    commandDefaultFlags = mempty,
252
253
254
255
256
257
258
259
260
261
262
    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"]
263
264
265
266
267
268
269
270
271
272
273
274
275
276
         "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")

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

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

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

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

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

302
      ,option [] ["http-transport"]
303
         "Set a transport for http(s) requests. Accepts 'curl', 'wget', 'powershell', and 'plain-http'. (default: 'curl')"
304
         globalHttpTransport (\v flags -> flags { globalHttpTransport = v })
305
         (reqArgFlag "HttpTransport")
306
      ]
307

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

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

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

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

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

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

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

360
361
362
363
364
365
366
367
-- | 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.
368
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
369
filterConfigureFlags flags cabalLibVersion
370
371
  -- NB: we expect the latest version to be the most common case,
  -- so test it first.
372
  | cabalLibVersion >= Version [1,23,0] [] = flags_latest
373
374
375
376
377
  -- 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.
378
379
  | cabalLibVersion <  Version [1,3,10] [] = flags_1_3_10
  | cabalLibVersion <  Version [1,10,0] [] = flags_1_10_0
380
  | cabalLibVersion <  Version [1,12,0] [] = flags_1_12_0
381
  | cabalLibVersion <  Version [1,14,0] [] = flags_1_14_0
382
  | cabalLibVersion <  Version [1,18,0] [] = flags_1_18_0
383
384
385
386
387
  | cabalLibVersion <  Version [1,19,1] [] = flags_1_19_1
  | cabalLibVersion <  Version [1,19,2] [] = flags_1_19_2
  | cabalLibVersion <  Version [1,21,1] [] = flags_1_21_1
  | cabalLibVersion <  Version [1,22,0] [] = flags_1_22_0
  | cabalLibVersion <  Version [1,23,0] [] = flags_1_23_0
388
  | otherwise = flags_latest
389
  where
390
391
392
    flags_latest = flags        {
      -- Cabal >= 1.19.1 uses '--dependency' and does not need '--constraint'.
      configConstraints = [],
393
      -- Passing '--allow-{older,newer}' to Setup.hs is unnecessary, we use
394
      -- '--exact-configuration' instead.
395
      configAllowOlder  = Just (Cabal.AllowOlder Cabal.RelaxDepsNone),
396
      configAllowNewer  = Just (Cabal.AllowNewer Cabal.RelaxDepsNone)
397
      }
398

399
    -- Cabal < 1.23 doesn't know about '--profiling-detail'.
400
401
402
    -- Cabal < 1.23 has a hacked up version of 'enable-profiling'
    -- which we shouldn't use.
    (tryLibProfiling, tryExeProfiling) = computeEffectiveProfiling flags
403
    flags_1_23_0 = flags_latest { configProfDetail    = NoFlag
404
                                , configProfLibDetail = NoFlag
405
406
407
408
409
                                , configIPID          = NoFlag
                                , configProf = mempty
                                , configProfExe = Flag tryExeProfiling
                                , configProfLib = Flag tryLibProfiling
                                }
410

411
    -- Cabal < 1.22 doesn't know about '--disable-debug-info'.
412
    flags_1_22_0 = flags_1_23_0 { configDebugInfo = NoFlag }
413

414
    -- Cabal < 1.21.1 doesn't know about 'disable-relocatable'
415
    -- Cabal < 1.21.1 doesn't know about 'enable-profiling'
416
    -- (but we already dealt with it in flags_1_23_0)
417
418
    flags_1_21_1 =
      flags_1_22_0 { configRelocatable = NoFlag
419
420
                   , configCoverage = NoFlag
                   , configLibCoverage = configCoverage flags
421
                   }
422
423
    -- Cabal < 1.19.2 doesn't know about '--exact-configuration' and
    -- '--enable-library-stripping'.
424
    flags_1_19_2 = flags_1_21_1 { configExactConfiguration = NoFlag
425
                                , configStripLibs = NoFlag }
426
    -- Cabal < 1.19.1 uses '--constraint' instead of '--dependency'.
427
    flags_1_19_1 = flags_1_19_2 { configDependencies = []
428
                                , configConstraints  = configConstraints flags }
429
    -- Cabal < 1.18.0 doesn't know about --extra-prog-path and --sysconfdir.
430
    flags_1_18_0 = flags_1_19_1 { configProgramPathExtra = toNubList []
431
432
                                , configInstallDirs = configInstallDirs_1_18_0}
    configInstallDirs_1_18_0 = (configInstallDirs flags) { sysconfdir = NoFlag }
433
    -- Cabal < 1.14.0 doesn't know about '--disable-benchmarks'.
434
    flags_1_14_0 = flags_1_18_0 { configBenchmarks  = NoFlag }
435
436
437
438
    -- 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 }
439
    -- Cabal < 1.10.0 doesn't know about '--disable-tests'.
440
    flags_1_10_0 = flags_1_12_0 { configTests       = NoFlag }
441
    -- Cabal < 1.3.10 does not grok the '--constraints' flag.
442
    flags_1_3_10 = flags_1_10_0 { configConstraints = [] }
443

444
445
-- | Get the package database settings from 'ConfigFlags', accounting for
-- @--package-db@ and @--user@ flags.
446
447
448
449
450
451
configPackageDB' :: ConfigFlags -> PackageDBStack
configPackageDB' cfg =
    interpretPackageDbFlags userInstall (configPackageDBs cfg)
  where
    userInstall = Cabal.fromFlagOrDefault True (configUserInstall cfg)

452
-- | Configure the compiler, but reduce verbosity during this step.
453
454
455
456
457
458
configCompilerAux' :: ConfigFlags -> IO (Compiler, Platform, ProgramDb)
configCompilerAux' configFlags =
  configCompilerAuxEx configFlags
    --FIXME: make configCompilerAux use a sensible verbosity
    { configVerbosity = fmap lessVerbose (configVerbosity configFlags) }

459
460
461
462
463
464
465
466
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
467
    configExConstraints:: [(UserConstraint, ConstraintSource)],
468
    configPreferences  :: [Dependency],
469
    configSolver       :: Flag PreSolver
470
  }
471
  deriving (Eq, Generic)
472
473

defaultConfigExFlags :: ConfigExFlags
474
defaultConfigExFlags = mempty { configSolver     = Flag defaultSolver }
475
476
477
478
479

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

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

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
511
512
513
514
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
515
516

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

518
519
520
  ]

instance Monoid ConfigExFlags where
521
  mempty = gmempty
522
523
524
  mappend = (<>)

instance Semigroup ConfigExFlags where
525
  (<>) = gmappend
526

ttuegel's avatar
ttuegel committed
527
528
529
530
531
532
reconfigureCommand :: CommandUI (ConfigFlags, ConfigExFlags)
reconfigureCommand
  = configureExCommand
    { commandName         = "reconfigure"
    , commandSynopsis     = "Reconfigure the package if necessary."
    , commandDescription  = Just $ \pname -> wrapText $
533
534
         "Run `configure` with the most recently used flags, or append FLAGS "
         ++ "to the most recently used configuration. "
ttuegel's avatar
ttuegel committed
535
         ++ "Accepts the same flags as `" ++ pname ++ " configure'. "
536
537
538
539
540
541
542
543
544
         ++ "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
545
546
547
548
    , commandUsage        = usageAlternatives "reconfigure" [ "[FLAGS]" ]
    , commandDefaultFlags = mempty
    }

ttuegel's avatar
ttuegel committed
549
550
551
552
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

553
554
555
556
557
558
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
559
} deriving Generic
560
561
562

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
563
  option [] ["only"]
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
  "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)

583
    parent = Cabal.buildCommand defaultProgramDb
584
585

instance Monoid BuildExFlags where
586
  mempty = gmempty
587
588
589
  mappend = (<>)

instance Semigroup BuildExFlags where
590
  (<>) = gmappend
591
592

-- ------------------------------------------------------------
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
-- * 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)

609
    parent = Cabal.replCommand defaultProgramDb
610

611
612
613
614
-- ------------------------------------------------------------
-- * Test command
-- ------------------------------------------------------------

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

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
633
634
    parent = Cabal.testCommand
    progDb = defaultProgramDb
635
636
637
638
639

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

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

Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
658
659
    parent = Cabal.benchmarkCommand
    progDb = defaultProgramDb
ttuegel's avatar
ttuegel committed
660

661
-- ------------------------------------------------------------
662
-- * Fetch command
663
-- ------------------------------------------------------------
664

665
666
667
668
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
669
      fetchSolver           :: Flag PreSolver,
670
      fetchMaxBackjumps     :: Flag Int,
671
      fetchReorderGoals     :: Flag ReorderGoals,
672
      fetchCountConflicts   :: Flag CountConflicts,
673
674
675
      fetchIndependentGoals :: Flag IndependentGoals,
      fetchShadowPkgs       :: Flag ShadowPkgs,
      fetchStrongFlags      :: Flag StrongFlags,
676
677
678
679
680
681
682
683
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
684
685
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
686
    fetchReorderGoals     = Flag (ReorderGoals False),
687
    fetchCountConflicts   = Flag (CountConflicts True),
688
689
690
    fetchIndependentGoals = Flag (IndependentGoals False),
    fetchShadowPkgs       = Flag (ShadowPkgs False),
    fetchStrongFlags      = Flag (StrongFlags False),
691
692
693
694
    fetchVerbosity = toFlag normal
   }

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

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
731
732
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
733
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
734
                         fetchCountConflicts   (\v flags -> flags { fetchCountConflicts   = v })
735
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
736
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
Andres Löh's avatar
Andres Löh committed
737
                         fetchStrongFlags      (\v flags -> flags { fetchStrongFlags      = v })
738

Duncan Coutts's avatar
Duncan Coutts committed
739
740
  }

741
742
743
744
745
746
-- ------------------------------------------------------------
-- * Freeze command
-- ------------------------------------------------------------

data FreezeFlags = FreezeFlags {
      freezeDryRun           :: Flag Bool,
747
748
      freezeTests            :: Flag Bool,
      freezeBenchmarks       :: Flag Bool,
749
750
      freezeSolver           :: Flag PreSolver,
      freezeMaxBackjumps     :: Flag Int,
751
      freezeReorderGoals     :: Flag ReorderGoals,
752
      freezeCountConflicts   :: Flag CountConflicts,
753
754
755
      freezeIndependentGoals :: Flag IndependentGoals,
      freezeShadowPkgs       :: Flag ShadowPkgs,
      freezeStrongFlags      :: Flag StrongFlags,
756
757
758
759
760
761
      freezeVerbosity        :: Flag Verbosity
    }

defaultFreezeFlags :: FreezeFlags
defaultFreezeFlags = FreezeFlags {
    freezeDryRun           = toFlag False,
762
763
    freezeTests            = toFlag False,
    freezeBenchmarks       = toFlag False,
764
765
    freezeSolver           = Flag defaultSolver,
    freezeMaxBackjumps     = Flag defaultMaxBackjumps,
766
    freezeReorderGoals     = Flag (ReorderGoals False),
767
    freezeCountConflicts   = Flag (CountConflicts True),
768
769
770
    freezeIndependentGoals = Flag (IndependentGoals False),
    freezeShadowPkgs       = Flag (ShadowPkgs False),
    freezeStrongFlags      = Flag (StrongFlags False),
771
772
773
774
775
776
777
    freezeVerbosity        = toFlag normal
   }

freezeCommand :: CommandUI FreezeFlags
freezeCommand = CommandUI {
    commandName         = "freeze",
    commandSynopsis     = "Freeze dependencies.",
778
779
780
781
782
783
784
785
    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",
786
    commandNotes        = Nothing,
787
    commandUsage        = usageFlags "freeze",
788
789
790
791
792
793
794
795
796
    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

797
798
799
800
801
802
803
804
805
806
       , 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 [] [])

807
808
809
810
811
812
       ] ++

       optionSolver      freezeSolver           (\v flags -> flags { freezeSolver           = v }) :
       optionSolverFlags showOrParseArgs
                         freezeMaxBackjumps     (\v flags -> flags { freezeMaxBackjumps     = v })
                         freezeReorderGoals     (\v flags -> flags { freezeReorderGoals     = v })
813
                         freezeCountConflicts   (\v flags -> flags { freezeCountConflicts   = v })
814
815
                         freezeIndependentGoals (\v flags -> flags { freezeIndependentGoals = v })
                         freezeShadowPkgs       (\v flags -> flags { freezeShadowPkgs       = v })
Andres Löh's avatar
Andres Löh committed
816
                         freezeStrongFlags      (\v flags -> flags { freezeStrongFlags      = v })
817
818
819

  }

820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
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 })
     ]
  }

836
837
838
839
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

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

855
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
856
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
857
    commandName         = "upgrade",
858
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
859
    commandDescription  = Nothing,
refold's avatar
refold committed
860
    commandUsage        = usageFlagsOrPackages "upgrade",
861
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
862
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
863
864
  }

Duncan Coutts's avatar
Duncan Coutts committed
865
866
867
868
869
870
871
872
873
874
875
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

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

892
893
894
895
896
formatCommand  :: CommandUI (Flag Verbosity)
formatCommand = CommandUI {
    commandName         = "format",
    commandSynopsis     = "Reformat the .cabal file using the standard style.",
    commandDescription  = Nothing,
897
    commandNotes        = Nothing,
898
    commandUsage        = usageAlternatives "format" ["[FILE]"],
899
900
901
902
    commandDefaultFlags = toFlag normal,
    commandOptions      = \_ -> []
  }

903
904
905
906
907
908
909
910
911
912
913
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
914
915
916
917
918
919
920
921
922
923
924
925
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]
  }

926
runCommand :: CommandUI (BuildFlags, BuildExFlags)
refold's avatar
refold committed
927
928
runCommand = CommandUI {
    commandName         = "run",
929
    commandSynopsis     = "Builds and runs an executable.",
930
    commandDescription  = Just $ \pname -> wrapText $
931
932
         "Builds and then runs the specified executable. If no executable is "
      ++ "specified, but the package contains just one executable, that one "
933
934
935
936
      ++ "is built and executed.\n"
      ++ "\n"
      ++ "Use `" ++ pname ++ " test --show-details=streaming` to run a "
      ++ "test-suite and get its full output.\n",
937
938
939
940
    commandNotes        = Just $ \pname ->
          "Examples:\n"
       ++ "  " ++ pname ++ " run\n"
       ++ "    Run the only executable in the current package;\n"
941
942
       ++ "  " ++ pname ++ " run foo -- --fooflag\n"
       ++ "    Works similar to `./foo --fooflag`.\n",
943
944
    commandUsage        = usageAlternatives "run"
        ["[FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]"],
refold's avatar
refold committed
945
    commandDefaultFlags = mempty,
946
947
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
948
                          (commandOptions parent showOrParseArgs)
949
950
951
                          ++
                          liftOptions snd setSnd
                          (buildExOptions showOrParseArgs)
refold's avatar
refold committed
952
953
  }
  where
954
955
956
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

957
    parent = Cabal.buildCommand defaultProgramDb
refold's avatar
refold committed
958

959
960
961
962
963
964
965
966
-- ------------------------------------------------------------
-- * Report flags
-- ------------------------------------------------------------

data ReportFlags = ReportFlags {
    reportUsername  :: Flag Username,
    reportPassword  :: Flag Password,
    reportVerbosity :: Flag Verbosity
967
  } deriving Generic
968
969
970
971
972
973
974
975
976

defaultReportFlags :: ReportFlags
defaultReportFlags = ReportFlags {
    reportUsername  = mempty,
    reportPassword  = mempty,
    reportVerbosity = toFlag normal
  }

reportCommand :: CommandUI ReportFlags
977
978
979
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
980
981
    commandDescription  = Nothing,
    commandNotes        = Just $ \_ ->
982
         "You can store your Hackage login in the ~/.cabal/config file\n",
983
    commandUsage        = usageAlternatives "report" ["[FLAGS]"],
984
985
986
987
988
989
990
991
992
993
994