Setup.hs 90 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.Verbosity
         ( Verbosity, normal )
100
import Distribution.Simple.Utils
101
         ( wrapText, wrapLine )
102
import Distribution.Client.GlobalFlags
Edsko de Vries's avatar
Edsko de Vries committed
103
104
105
         ( GlobalFlags(..), defaultGlobalFlags
         , RepoContext(..), withRepoContext
         )
106

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

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

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

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

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

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

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

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

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

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

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

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

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

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

346
347
348
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

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

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

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

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

409
410
411
412
413
414
415
416
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

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

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

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

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

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

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

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

477
  ]
cheecheeo's avatar
cheecheeo committed
478
  where allowNewerArgument = "DEPS"
479
480
481
482

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
483
    configExConstraints= mempty,
484
    configPreferences  = mempty,
485
486
    configSolver       = mempty,
    configAllowNewer   = mempty
487
488
489
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
490
    configExConstraints= combine configExConstraints,
491
    configPreferences  = combine configPreferences,
492
493
    configSolver       = combine configSolver,
    configAllowNewer   = combine configAllowNewer
494
495
496
  }
    where combine field = field a `mappend` field b

ttuegel's avatar
ttuegel committed
497
498
499
500
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

501
502
503
504
505
506
507
508
509
510
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
}

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
511
  option [] ["only"]
512
513
514
515
516
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
542
  "Don't reinstall add-source dependencies (sandbox-only)"
  buildOnly (\v flags -> flags { buildOnly = v })
  (noArg (Flag SkipAddSourceDepsCheck))

  : []

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

    parent = Cabal.buildCommand defaultProgramConfiguration

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

-- ------------------------------------------------------------
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
-- * 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

561
562
563
564
-- ------------------------------------------------------------
-- * Test command
-- ------------------------------------------------------------

565
testCommand :: CommandUI (TestFlags, BuildFlags, BuildExFlags)
566
testCommand = parent {
567
568
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
569
  commandOptions      =
570
    \showOrParseArgs -> liftOptions get1 set1
571
572
                        (commandOptions parent showOrParseArgs)
                        ++
573
574
575
576
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
577
578
  }
  where
579
580
581
    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)
582

583
584
    parent   = Cabal.testCommand
    progConf = defaultProgramConfiguration
585
586
587
588
589

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

590
benchmarkCommand :: CommandUI (BenchmarkFlags, BuildFlags, BuildExFlags)
591
benchmarkCommand = parent {
592
593
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
594
  commandOptions      =
595
    \showOrParseArgs -> liftOptions get1 set1
596
597
                        (commandOptions parent showOrParseArgs)
                        ++
598
599
600
601
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
ttuegel's avatar
ttuegel committed
602
  }
603
  where
604
605
606
    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)
607

608
609
    parent   = Cabal.benchmarkCommand
    progConf = defaultProgramConfiguration
ttuegel's avatar
ttuegel committed
610

611
-- ------------------------------------------------------------
612
-- * Fetch command
613
-- ------------------------------------------------------------
614

615
616
617
618
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
619
      fetchSolver           :: Flag PreSolver,
620
621
622
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
623
      fetchShadowPkgs       :: Flag Bool,
Andres Löh's avatar
Andres Löh committed
624
      fetchStrongFlags      :: Flag Bool,
625
626
627
628
629
630
631
632
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
633
634
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
635
    fetchReorderGoals     = Flag False,
636
    fetchIndependentGoals = Flag False,
637
    fetchShadowPkgs       = Flag False,
Andres Löh's avatar
Andres Löh committed
638
    fetchStrongFlags      = Flag False,
639
640
641
642
    fetchVerbosity = toFlag normal
   }

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

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
679
680
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
681
682
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
683
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
Andres Löh's avatar
Andres Löh committed
684
                         fetchStrongFlags      (\v flags -> flags { fetchStrongFlags      = v })
685

Duncan Coutts's avatar
Duncan Coutts committed
686
687
  }

688
689
690
691
692
693
-- ------------------------------------------------------------
-- * Freeze command
-- ------------------------------------------------------------

data FreezeFlags = FreezeFlags {
      freezeDryRun           :: Flag Bool,
694
695
      freezeTests            :: Flag Bool,
      freezeBenchmarks       :: Flag Bool,
696
697
698
699
700
      freezeSolver           :: Flag PreSolver,
      freezeMaxBackjumps     :: Flag Int,
      freezeReorderGoals     :: Flag Bool,
      freezeIndependentGoals :: Flag Bool,
      freezeShadowPkgs       :: Flag Bool,
Andres Löh's avatar
Andres Löh committed
701
      freezeStrongFlags      :: Flag Bool,
702
703
704
705
706
707
      freezeVerbosity        :: Flag Verbosity
    }

defaultFreezeFlags :: FreezeFlags
defaultFreezeFlags = FreezeFlags {
    freezeDryRun           = toFlag False,
708
709
    freezeTests            = toFlag False,
    freezeBenchmarks       = toFlag False,
710
711
    freezeSolver           = Flag defaultSolver,
    freezeMaxBackjumps     = Flag defaultMaxBackjumps,
712
    freezeReorderGoals     = Flag False,
713
714
    freezeIndependentGoals = Flag False,
    freezeShadowPkgs       = Flag False,
Andres Löh's avatar
Andres Löh committed
715
    freezeStrongFlags      = Flag False,
716
717
718
719
720
721
722
    freezeVerbosity        = toFlag normal
   }

freezeCommand :: CommandUI FreezeFlags
freezeCommand = CommandUI {
    commandName         = "freeze",
    commandSynopsis     = "Freeze dependencies.",
723
724
725
726
727
728
729
730
    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",
731
    commandNotes        = Nothing,
732
    commandUsage        = usageFlags "freeze",
733
734
735
736
737
738
739
740
741
    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

742
743
744
745
746
747
748
749
750
751
       , 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 [] [])

752
753
754
755
756
757
758
759
       ] ++

       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
760
                         freezeStrongFlags      (\v flags -> flags { freezeStrongFlags      = v })
761
762
763

  }

764
765
766
767
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

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

783
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
784
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
785
    commandName         = "upgrade",
786
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
787
    commandDescription  = Nothing,
refold's avatar
refold committed
788
    commandUsage        = usageFlagsOrPackages "upgrade",
789
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
790
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
791
792
  }

Duncan Coutts's avatar
Duncan Coutts committed
793
794
795
796
797
798
799
800
801
802
803
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

804
805
806
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
807
    commandSynopsis     = "Check the package for common mistakes.",
808
809
810
811
812
813
    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",
814
    commandNotes        = Nothing,
815
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
816
    commandDefaultFlags = toFlag normal,
817
    commandOptions      = \_ -> []
818
819
  }

820
821
822
823
824
formatCommand  :: CommandUI (Flag Verbosity)
formatCommand = CommandUI {
    commandName         = "format",
    commandSynopsis     = "Reformat the .cabal file using the standard style.",
    commandDescription  = Nothing,
825
    commandNotes        = Nothing,
826
    commandUsage        = usageAlternatives "format" ["[FILE]"],
827
828
829
830
    commandDefaultFlags = toFlag normal,
    commandOptions      = \_ -> []
  }

831
832
833
834
835
836
837
838
839
840
841
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
842
843
844
845
846
847
848
849
850
851
852
853
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]
  }

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

885
    parent = Cabal.buildCommand defaultProgramConfiguration
refold's avatar
refold committed
886

887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
-- ------------------------------------------------------------
-- * 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
905
906
907
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
908
909
    commandDescription  = Nothing,
    commandNotes        = Just $ \_ ->
910
         "You can store your Hackage login in the ~/.cabal/config file\n",
911
    commandUsage        = usageAlternatives "report" ["[FLAGS]"],
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
    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))
      ]
928
929
  }

930
931
932
933
934
935
936
937
938
939
940
941
942
instance Monoid ReportFlags where
  mempty = ReportFlags {
    reportUsername  = mempty,
    reportPassword  = mempty,
    reportVerbosity = mempty
  }
  mappend a b = ReportFlags {
    reportUsername  = combine reportUsername,
    reportPassword  = combine reportPassword,
    reportVerbosity = combine reportVerbosity
  }
    where combine field = field a `mappend` field b

943
-- ------------------------------------------------------------
944
-- * Get flags
945
946
-- ------------------------------------------------------------

947
948
949
950
951
952
data GetFlags = GetFlags {
    getDestDir          :: Flag FilePath,
    getPristine         :: Flag Bool,
    getSourceRepository :: Flag (Maybe RepoKind),
    getVerbosity        :: Flag Verbosity
  }
953

954
955
956
957
958
959
defaultGetFlags :: GetFlags
defaultGetFlags = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = toFlag normal
960
961
   }

962
963
964
getCommand :: CommandUI GetFlags
getCommand = CommandUI {
    commandName         = "get",
965
966
    commandSynopsis     = "Download/Extract a package's source code (repository).",
    commandDescription  = Just $ \_ -> wrapText $
967
968
969
970
          "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",
971
972
973
974
    commandNotes        = Just $ \pname ->
          "Examples:\n"
       ++ "  " ++ pname ++ " get hlint\n"
       ++ "    Download the latest stable version of hlint;\n"
975
       ++ "  " ++ pname ++ " get lens --source-repository=head\n"
976
       ++ "    Download the source repository (i.e. git clone from github).\n",
977
    commandUsage        = usagePackages "get",
978
    commandDefaultFlags = defaultGetFlags,
979
    commandOptions      = \_ -> [
980
        optionVerbosity getVerbosity (\v flags -> flags { getVerbosity = v })
981
982

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

987
       ,option "s" ["source-repository"]
988
         "Copy the package's source repository (ie git clone, darcs get, etc as appropriate)."
989
990
991
992
993
994
         getSourceRepository (\v flags -> flags { getSourceRepository = v })
        (optArg "[head|this|...]" (readP_to_E (const "invalid source-repository")
                                              (fmap (toFlag . Just) parse))
                                  (Flag Nothing)
                                  (map (fmap show) . flagToList))

995
996
997
       , option [] ["pristine"]
           ("Unpack the original pristine tarball, rather than updating the "
           ++ ".cabal file with the latest revision from the package archive.")
998
           getPristine (\v flags -> flags { getPristine = v })
999
           trueArg
1000
       ]