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

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

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

69

70
import Distribution.Simple.Compiler (PackageDB)
71
72
import Distribution.Simple.Program
         ( defaultProgramConfiguration )
73
74
import Distribution.Simple.Command hiding (boolOpt, boolOpt')
import qualified Distribution.Simple.Command as Command
Duncan Coutts's avatar
Duncan Coutts committed
75
import qualified Distribution.Simple.Setup as Cabal
76
import Distribution.Simple.Setup
77
78
         ( ConfigFlags(..), BuildFlags(..), ReplFlags
         , TestFlags(..), BenchmarkFlags(..)
79
         , SDistFlags(..), HaddockFlags(..)
80
         , readPackageDbList, showPackageDbList
Edsko de Vries's avatar
Edsko de Vries committed
81
         , Flag(..), toFlag, flagToMaybe, flagToList
82
         , optionVerbosity, boolOpt, boolOpt', trueArg, falseArg, optionNumJobs )
83
import Distribution.Simple.InstallDirs
84
85
         ( PathTemplate, InstallDirs(sysconfdir)
         , toPathTemplate, fromPathTemplate )
86
import Distribution.Version
Duncan Coutts's avatar
Duncan Coutts committed
87
         ( Version(Version), anyVersion, thisVersion )
88
import Distribution.Package
89
         ( PackageIdentifier, packageName, packageVersion, Dependency(..) )
90
import Distribution.PackageDescription
91
         ( BuildType(..), RepoKind(..) )
92
import Distribution.Text
93
         ( Text(..), display )
94
import Distribution.ReadE
95
         ( ReadE(..), readP_to_E, succeedReadE )
96
import qualified Distribution.Compat.ReadP as Parse
97
         ( ReadP, readP_to_S, readS_to_P, char, munch1, pfail, sepBy1, (+++) )
98
99
import Distribution.Compat.Semigroup
         ( Semigroup((<>)) )
100
101
import Distribution.Verbosity
         ( Verbosity, normal )
102
import Distribution.Simple.Utils
103
         ( wrapText, wrapLine )
104
import Distribution.Client.GlobalFlags
Edsko de Vries's avatar
Edsko de Vries committed
105
106
107
         ( GlobalFlags(..), defaultGlobalFlags
         , RepoContext(..), withRepoContext
         )
108

109
110
import Data.Char
         ( isSpace, isAlphaNum )
111
import Data.List
112
         ( intercalate, deleteFirstsBy )
113
import Data.Maybe
114
         ( listToMaybe, maybeToList, fromMaybe )
115
#if !MIN_VERSION_base(4,8,0)
116
117
import Data.Monoid
         ( Monoid(..) )
118
#endif
119
120
import GHC.Generics (Generic)
import Distribution.Compat.Binary (Binary)
121
122
123
124
125
126
import Control.Monad
         ( liftM )
import System.FilePath
         ( (</>) )
import Network.URI
         ( parseAbsoluteURI, uriToString )
127

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

268
      ,option [] ["sandbox-config-file"]
269
         "Set an alternate location for the sandbox config file (default: './cabal.sandbox.config')"
270
271
272
         globalConfigFile (\v flags -> flags { globalSandboxConfigFile = v })
         (reqArgFlag "FILE")

U-CIQDEV\gbazerman's avatar
U-CIQDEV\gbazerman committed
273
274
      ,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
275
276
277
         globalConfigFile (\v flags -> flags {globalConstraintsFile = v})
         (reqArgFlag "FILE")

278
      ,option [] ["require-sandbox"]
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
279
         "requiring the presence of a sandbox for sandbox-aware commands"
280
281
282
         globalRequireSandbox (\v flags -> flags { globalRequireSandbox = v })
         (boolOpt' ([], ["require-sandbox"]) ([], ["no-require-sandbox"]))

283
284
285
286
287
      ,option [] ["ignore-sandbox"]
         "Ignore any existing sandbox"
         globalIgnoreSandbox (\v flags -> flags { globalIgnoreSandbox = v })
         trueArg

288
      ,option [] ["ignore-expiry"]
Edsko de Vries's avatar
Edsko de Vries committed
289
         "Ignore expiry dates on signed metadata (use only in exceptional circumstances)"
290
291
292
         globalIgnoreExpiry (\v flags -> flags { globalIgnoreExpiry = v })
         trueArg

293
      ,option [] ["http-transport"]
294
         "Set a transport for http(s) requests. Accepts 'curl', 'wget', 'powershell', and 'plain-http'. (default: 'curl')"
295
296
         globalConfigFile (\v flags -> flags { globalHttpTransport = v })
         (reqArgFlag "HttpTransport")
297
      ]
298

299
300
301
302
    -- arguments we don't want shown in the help
    argsNotShown :: [OptionField GlobalFlags]
    argsNotShown = [
       option [] ["remote-repo"]
303
304
         "The name and url for a remote repository"
         globalRemoteRepos (\v flags -> flags { globalRemoteRepos = v })
305
         (reqArg' "NAME:URL" (toNubList . maybeToList . readRepo) (map showRepo . fromNubList))
306
307
308
309
310
311
312
313
314

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

317
318
319
320
321
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

322
323
324
325
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
326
327
328
329
330
      ]

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

332
configureCommand :: CommandUI ConfigFlags
333
334
configureCommand = c
  { commandDefaultFlags = mempty
335
336
337
  , commandNotes = Just $ \pname -> (case commandNotes c of
         Nothing -> ""
         Just n  -> n pname ++ "\n")
338
339
340
341
342
343
       ++ "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
344
  }
345
346
 where
  c = Cabal.configureCommand defaultProgramConfiguration
Duncan Coutts's avatar
Duncan Coutts committed
347

348
349
350
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

351
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
352
filterConfigureFlags flags cabalLibVersion
353
  | cabalLibVersion >= Version [1,23,0] [] = flags_latest
354
  -- ^ NB: we expect the latest version to be the most common case.
355
356
  | cabalLibVersion <  Version [1,3,10] [] = flags_1_3_10
  | cabalLibVersion <  Version [1,10,0] [] = flags_1_10_0
357
  | cabalLibVersion <  Version [1,12,0] [] = flags_1_12_0
358
  | cabalLibVersion <  Version [1,14,0] [] = flags_1_14_0
359
  | cabalLibVersion <  Version [1,18,0] [] = flags_1_18_0
360
  | cabalLibVersion <  Version [1,19,1] [] = flags_1_19_0
361
  | cabalLibVersion <  Version [1,19,2] [] = flags_1_19_1
362
  | cabalLibVersion <  Version [1,21,1] [] = flags_1_20_0
363
  | cabalLibVersion <  Version [1,22,0] [] = flags_1_21_0
364
  | cabalLibVersion <  Version [1,23,0] [] = flags_1_22_0
365
  | otherwise = flags_latest
366
  where
367
    -- Cabal >= 1.19.1 uses '--dependency' and does not need '--constraint'.
368
369
    flags_latest = flags        { configConstraints = [] }

370
371
    -- Cabal < 1.23 doesn't know about '--profiling-detail'.
    flags_1_22_0 = flags_latest { configProfDetail    = NoFlag
372
373
                                , configProfLibDetail = NoFlag
                                , configIPID          = NoFlag }
374

375
    -- Cabal < 1.22 doesn't know about '--disable-debug-info'.
376
    flags_1_21_0 = flags_1_22_0 { configDebugInfo = NoFlag }
377

378
    -- Cabal < 1.21.1 doesn't know about 'disable-relocatable'
379
380
    -- Cabal < 1.21.1 doesn't know about 'enable-profiling'
    flags_1_20_0 =
381
      flags_1_21_0 { configRelocatable = NoFlag
382
383
384
385
                   , configProf = NoFlag
                   , configProfExe = configProf flags
                   , configProfLib =
                     mappend (configProf flags) (configProfLib flags)
386
387
                   , configCoverage = NoFlag
                   , configLibCoverage = configCoverage flags
388
                   }
389
390
391
392
    -- 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 }
393
394
395
    -- Cabal < 1.19.1 uses '--constraint' instead of '--dependency'.
    flags_1_19_0 = flags_1_19_1 { configDependencies = []
                                , configConstraints  = configConstraints flags }
396
    -- Cabal < 1.18.0 doesn't know about --extra-prog-path and --sysconfdir.
397
    flags_1_18_0 = flags_1_19_0 { configProgramPathExtra = toNubList []
398
399
                                , configInstallDirs = configInstallDirs_1_18_0}
    configInstallDirs_1_18_0 = (configInstallDirs flags) { sysconfdir = NoFlag }
400
    -- Cabal < 1.14.0 doesn't know about '--disable-benchmarks'.
401
    flags_1_14_0 = flags_1_18_0 { configBenchmarks  = NoFlag }
402
403
404
405
    -- 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 }
406
    -- Cabal < 1.10.0 doesn't know about '--disable-tests'.
407
    flags_1_10_0 = flags_1_12_0 { configTests       = NoFlag }
408
    -- Cabal < 1.3.10 does not grok the '--constraints' flag.
409
    flags_1_3_10 = flags_1_10_0 { configConstraints = [] }
410

411
412
413
414
415
416
417
418
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
419
    configExConstraints:: [(UserConstraint, ConstraintSource)],
420
    configPreferences  :: [Dependency],
421
422
    configSolver       :: Flag PreSolver,
    configAllowNewer   :: Flag AllowNewer
423
  }
424
  deriving (Eq, Generic)
425
426

defaultConfigExFlags :: ConfigExFlags
427
428
defaultConfigExFlags = mempty { configSolver     = Flag defaultSolver
                              , configAllowNewer = Flag AllowNewerNone }
429
430
431
432
433

configureExCommand :: CommandUI (ConfigFlags, ConfigExFlags)
configureExCommand = configureCommand {
    commandDefaultFlags = (mempty, defaultConfigExFlags),
    commandOptions      = \showOrParseArgs ->
434
         liftOptions fst setFst
435
         (filter ((`notElem` ["constraint", "dependency", "exact-configuration"])
436
                  . optionName) $ configureOptions  showOrParseArgs)
437
438
      ++ liftOptions snd setSnd
         (configureExOptions showOrParseArgs ConstraintSourceCommandlineFlag)
439
440
441
442
443
  }
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

444
445
446
447
configureExOptions :: ShowOrParseArgs
                   -> ConstraintSource
                   -> [OptionField ConfigExFlags]
configureExOptions _showOrParseArgs src =
448
449
450
451
452
453
454
  [ 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))
455
456
457
458
  , option [] ["constraint"]
      "Specify constraints on a package (version, installed/source, flags)"
      configExConstraints (\v flags -> flags { configExConstraints = v })
      (reqArg "CONSTRAINT"
459
460
              ((\x -> [(x, src)]) `fmap` ReadE readUserConstraint)
              (map $ display . fst))
461
462
463
464

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
465
466
467
468
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
469
470

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

  , option [] ["allow-newer"]
cheecheeo's avatar
cheecheeo committed
473
    ("Ignore upper bounds in all dependencies or " ++ allowNewerArgument)
474
    configAllowNewer (\v flags -> flags { configAllowNewer = v})
cheecheeo's avatar
cheecheeo committed
475
    (optArg allowNewerArgument
476
477
478
     (fmap Flag allowNewerParser) (Flag AllowNewerAll)
     allowNewerPrinter)

479
  ]
cheecheeo's avatar
cheecheeo committed
480
  where allowNewerArgument = "DEPS"
481
482
483
484

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
485
    configExConstraints= mempty,
486
    configPreferences  = mempty,
487
488
    configSolver       = mempty,
    configAllowNewer   = mempty
489
  }
490
491
492
493
  mappend = (<>)

instance Semigroup ConfigExFlags where
  a <> b = ConfigExFlags {
494
    configCabalVersion = combine configCabalVersion,
495
    configExConstraints= combine configExConstraints,
496
    configPreferences  = combine configPreferences,
497
498
    configSolver       = combine configSolver,
    configAllowNewer   = combine configAllowNewer
499
500
501
  }
    where combine field = field a `mappend` field b

ttuegel's avatar
ttuegel committed
502
503
504
505
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

506
507
508
509
510
511
512
513
514
515
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
}

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
516
  option [] ["only"]
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
  "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
  }
542
543
544
545
  mappend = (<>)

instance Semigroup BuildExFlags where
  a <> b = BuildExFlags {
546
547
548
549
550
    buildOnly    = combine buildOnly
  }
    where combine field = field a `mappend` field b

-- ------------------------------------------------------------
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
-- * 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

569
570
571
572
-- ------------------------------------------------------------
-- * Test command
-- ------------------------------------------------------------

573
testCommand :: CommandUI (TestFlags, BuildFlags, BuildExFlags)
574
testCommand = parent {
575
576
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
577
  commandOptions      =
578
    \showOrParseArgs -> liftOptions get1 set1
579
580
                        (commandOptions parent showOrParseArgs)
                        ++
581
582
583
584
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
585
586
  }
  where
587
588
589
    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)
590

591
592
    parent   = Cabal.testCommand
    progConf = defaultProgramConfiguration
593
594
595
596
597

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

598
benchmarkCommand :: CommandUI (BenchmarkFlags, BuildFlags, BuildExFlags)
599
benchmarkCommand = parent {
600
601
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
602
  commandOptions      =
603
    \showOrParseArgs -> liftOptions get1 set1
604
605
                        (commandOptions parent showOrParseArgs)
                        ++
606
607
608
609
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
ttuegel's avatar
ttuegel committed
610
  }
611
  where
612
613
614
    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)
615

616
617
    parent   = Cabal.benchmarkCommand
    progConf = defaultProgramConfiguration
ttuegel's avatar
ttuegel committed
618

619
-- ------------------------------------------------------------
620
-- * Fetch command
621
-- ------------------------------------------------------------
622

623
624
625
626
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
627
      fetchSolver           :: Flag PreSolver,
628
629
630
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
631
      fetchShadowPkgs       :: Flag Bool,
Andres Löh's avatar
Andres Löh committed
632
      fetchStrongFlags      :: Flag Bool,
633
634
635
636
637
638
639
640
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
641
642
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
643
    fetchReorderGoals     = Flag False,
644
    fetchIndependentGoals = Flag False,
645
    fetchShadowPkgs       = Flag False,
Andres Löh's avatar
Andres Löh committed
646
    fetchStrongFlags      = Flag False,
647
648
649
650
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
651
652
fetchCommand = CommandUI {
    commandName         = "fetch",
653
    commandSynopsis     = "Downloads packages for later installation.",
654
655
656
657
658
    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",
659
    commandNotes        = Nothing,
660
    commandDefaultFlags = defaultFetchFlags,
661
    commandOptions      = \ showOrParseArgs -> [
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
         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
683
684
685
686

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
687
688
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
689
690
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
691
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
Andres Löh's avatar
Andres Löh committed
692
                         fetchStrongFlags      (\v flags -> flags { fetchStrongFlags      = v })
693

Duncan Coutts's avatar
Duncan Coutts committed
694
695
  }

696
697
698
699
700
701
-- ------------------------------------------------------------
-- * Freeze command
-- ------------------------------------------------------------

data FreezeFlags = FreezeFlags {
      freezeDryRun           :: Flag Bool,
702
703
      freezeTests            :: Flag Bool,
      freezeBenchmarks       :: Flag Bool,
704
705
706
707
708
      freezeSolver           :: Flag PreSolver,
      freezeMaxBackjumps     :: Flag Int,
      freezeReorderGoals     :: Flag Bool,
      freezeIndependentGoals :: Flag Bool,
      freezeShadowPkgs       :: Flag Bool,
Andres Löh's avatar
Andres Löh committed
709
      freezeStrongFlags      :: Flag Bool,
710
711
712
713
714
715
      freezeVerbosity        :: Flag Verbosity
    }

defaultFreezeFlags :: FreezeFlags
defaultFreezeFlags = FreezeFlags {
    freezeDryRun           = toFlag False,
716
717
    freezeTests            = toFlag False,
    freezeBenchmarks       = toFlag False,
718
719
    freezeSolver           = Flag defaultSolver,
    freezeMaxBackjumps     = Flag defaultMaxBackjumps,
720
    freezeReorderGoals     = Flag False,
721
722
    freezeIndependentGoals = Flag False,
    freezeShadowPkgs       = Flag False,
Andres Löh's avatar
Andres Löh committed
723
    freezeStrongFlags      = Flag False,
724
725
726
727
728
729
730
    freezeVerbosity        = toFlag normal
   }

freezeCommand :: CommandUI FreezeFlags
freezeCommand = CommandUI {
    commandName         = "freeze",
    commandSynopsis     = "Freeze dependencies.",
731
732
733
734
735
736
737
738
    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",
739
    commandNotes        = Nothing,
740
    commandUsage        = usageFlags "freeze",
741
742
743
744
745
746
747
748
749
    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

750
751
752
753
754
755
756
757
758
759
       , 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 [] [])

760
761
762
763
764
765
766
767
       ] ++

       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
768
                         freezeStrongFlags      (\v flags -> flags { freezeStrongFlags      = v })
769
770
771

  }

772
773
774
775
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

776
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
777
778
updateCommand = CommandUI {
    commandName         = "update",
779
    commandSynopsis     = "Updates list of known packages.",
780
781
782
    commandDescription  = Just $ \_ ->
      "For all known remote repositories, download the package list.\n",
    commandNotes        = Just $ \_ ->
783
784
785
      relevantConfigValuesText ["remote-repo"
                               ,"remote-repo-cache"
                               ,"local-repo"],
refold's avatar
refold committed
786
    commandUsage        = usageFlags "update",
787
    commandDefaultFlags = toFlag normal,
788
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
789
790
  }

791
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
792
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
793
    commandName         = "upgrade",
794
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
795
    commandDescription  = Nothing,
refold's avatar
refold committed
796
    commandUsage        = usageFlagsOrPackages "upgrade",
797
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
798
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
799
800
  }

Duncan Coutts's avatar
Duncan Coutts committed
801
802
803
804
805
806
807
808
809
810
811
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

812
813
814
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
815
    commandSynopsis     = "Check the package for common mistakes.",
816
817
818
819
820
821
    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",
822
    commandNotes        = Nothing,
823
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
824
    commandDefaultFlags = toFlag normal,
825
    commandOptions      = \_ -> []
826
827
  }

828
829
830
831
832
formatCommand  :: CommandUI (Flag Verbosity)
formatCommand = CommandUI {
    commandName         = "format",
    commandSynopsis     = "Reformat the .cabal file using the standard style.",
    commandDescription  = Nothing,
833
    commandNotes        = Nothing,
834
    commandUsage        = usageAlternatives "format" ["[FILE]"],
835
836
837
838
    commandDefaultFlags = toFlag normal,
    commandOptions      = \_ -> []
  }

839
840
841
842
843
844
845
846
847
848
849
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
850
851
852
853
854
855
856
857
858
859
860
861
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]
  }

862
runCommand :: CommandUI (BuildFlags, BuildExFlags)
refold's avatar
refold committed
863
864
runCommand = CommandUI {
    commandName         = "run",
865
    commandSynopsis     = "Builds and runs an executable.",
866
    commandDescription  = Just $ \pname -> wrapText $
867
868
         "Builds and then runs the specified executable. If no executable is "
      ++ "specified, but the package contains just one executable, that one "
869
870
871
872
      ++ "is built and executed.\n"
      ++ "\n"
      ++ "Use `" ++ pname ++ " test --show-details=streaming` to run a "
      ++ "test-suite and get its full output.\n",
873
874
875
876
    commandNotes        = Just $ \pname ->
          "Examples:\n"
       ++ "  " ++ pname ++ " run\n"
       ++ "    Run the only executable in the current package;\n"
877
878
       ++ "  " ++ pname ++ " run foo -- --fooflag\n"
       ++ "    Works similar to `./foo --fooflag`.\n",
879
880
    commandUsage        = usageAlternatives "run"
        ["[FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]"],
refold's avatar
refold committed
881
    commandDefaultFlags = mempty,
882
883
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
884
                          (commandOptions parent showOrParseArgs)
885
886
887
                          ++
                          liftOptions snd setSnd
                          (buildExOptions showOrParseArgs)
refold's avatar
refold committed
888
889
  }
  where
890
891
892
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

893
    parent = Cabal.buildCommand defaultProgramConfiguration
refold's avatar
refold committed
894

895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
-- ------------------------------------------------------------
-- * Report flags
-- ------------------------------------------------------------

data ReportFlags = ReportFlags {
    reportUsername  :: Flag Username,
    reportPassword  :: Flag Password,
    reportVerbosity :: Flag Verbosity
  }

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

reportCommand :: CommandUI ReportFlags
913
914
915
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
916
917
    commandDescription  = Nothing,
    commandNotes        = Just $ \_ ->
918
         "You can store your Hackage login in the ~/.cabal/config file\n",
919
    commandUsage        = usageAlternatives "report" ["[FLAGS]"],
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
    commandDefaultFlags = defaultReportFlags,
    commandOptions      = \_ ->
      [optionVerbosity reportVerbosity (\v flags -> flags { reportVerbosity = v })

      ,option ['u'] ["username"]
        "Hackage username."
        reportUsername (\v flags -> flags { reportUsername = v })
        (reqArg' "USERNAME" (toFlag . Username)
                            (flagToList . fmap unUsername))

      ,option ['p'] ["password"]
        "Hackage password."
        reportPassword (\v flags -> flags { reportPassword = v })
        (reqArg' "PASSWORD" (toFlag . Password)
                            (flagToList . fmap unPassword))
      ]
936
937
  }

938
939
940
941
942
943
instance Monoid ReportFlags where
  mempty = ReportFlags {
    reportUsername  = mempty,
    reportPassword  = mempty,
    reportVerbosity = mempty
  }
944
945
946
947
  mappend = (<>)

instance Semigroup ReportFlags where
  a <> b = ReportFlags {
948
949
950
951
952
953
    reportUsername  = combine reportUsername,
    reportPassword  = combine reportPassword,
    reportVerbosity = combine reportVerbosity
  }
    where combine field = field a `mappend` field b

954
-- ------------------------------------------------------------
955
-- * Get flags
956
957
-- ------------------------------------------------------------

958
959
960
961
962
963
data GetFlags = GetFlags {
    getDestDir          :: Flag FilePath,
    getPristine         :: Flag Bool,
    getSourceRepository :: Flag (Maybe RepoKind),
    getVerbosity        :: Flag Verbosity
  }
964

965
966
967
968
969
970
defaultGetFlags :: GetFlags
defaultGetFlags = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = toFlag normal
971
972
   }

973
974
975
getCommand :: CommandUI GetFlags
getCommand = CommandUI {
    commandName         = "get",
976
977
    commandSynopsis     = "Download/Extract a package's source code (repository).",
    commandDescription  = Just $ \_ -> wrapText $
978
979
980
981
          "Creates a local copy of a package's source code. By default it gets "
       ++ "the source\ntarball and unpacks it in a local subdirectory. "
       ++ "Alternatively, with -s it will\nget the code from the source "
       ++ "repository specified by the package.\n",
982
983
984
985
    commandNotes        = Just $ \pname ->
          "Examples:\n"
       ++ "  " ++ pname ++ " get hlint\n"
       ++ "    Download the latest stable version of hlint;\n"
986
       ++ "  " ++ pname ++ " get lens --source-repository=head\n"
987
       ++ "    Download the source repository (i.e. git clone from github).\n",
988
    commandUsage        = usagePackages "get",
989
    commandDefaultFlags = defaultGetFlags,
990
    commandOptions      = \_ -> [
991
        optionVerbosity getVerbosity (\v flags -> flags { getVerbosity = v })
992
993

       ,option "d" ["destdir"]
refold's avatar
refold committed
994
         "Where to place the package source, defaults to the current directory."
995
         getDestDir (\v flags -> flags { getDestDir = v })
996
         (reqArgFlag "PATH")
997

998
       ,option "s" ["source-repository"]
999
         "Copy the package's source repository (ie git clone, darcs get, etc as appropriate)."
1000
         getSourceRepository (\v flags -> flags { getSourceRepository = v })