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

    , parsePackageArgs
40
41
42
    --TODO: stop exporting these:
    , showRepo
    , parseRepo
43
44
    ) where

45
import Distribution.Client.Types
46
         ( Username(..), Password(..), Repo(..), RemoteRepo(..), LocalRepo(..) )
47
48
import Distribution.Client.BuildReports.Types
         ( ReportLevel(..) )
49
import Distribution.Client.Dependency.Types
50
         ( AllowNewer(..), PreSolver(..) )
51
52
import qualified Distribution.Client.Init.Types as IT
         ( InitFlags(..), PackageType(..) )
53
54
import Distribution.Client.Targets
         ( UserConstraint, readUserConstraint )
55

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

88
89
import Data.Char
         ( isSpace, isAlphaNum )
90
91
import Data.List
         ( intercalate )
92
import Data.Maybe
93
         ( listToMaybe, maybeToList, fromMaybe )
94
95
96
97
98
99
100
101
import Data.Monoid
         ( Monoid(..) )
import Control.Monad
         ( liftM )
import System.FilePath
         ( (</>) )
import Network.URI
         ( parseAbsoluteURI, uriToString )
102

103
104
105
106
107
108
-- ------------------------------------------------------------
-- * Global flags
-- ------------------------------------------------------------

-- | Flags that apply at the top level, not to any sub-command.
data GlobalFlags = GlobalFlags {
109
110
111
112
113
114
115
116
    globalVersion           :: Flag Bool,
    globalNumericVersion    :: Flag Bool,
    globalConfigFile        :: Flag FilePath,
    globalSandboxConfigFile :: Flag FilePath,
    globalRemoteRepos       :: [RemoteRepo],     -- ^ Available Hackage servers.
    globalCacheDir          :: Flag FilePath,
    globalLocalRepos        :: [FilePath],
    globalLogsDir           :: Flag FilePath,
117
    globalWorldFile         :: Flag FilePath,
118
119
    globalRequireSandbox    :: Flag Bool,
    globalIgnoreSandbox     :: Flag Bool
120
  }
Duncan Coutts's avatar
Duncan Coutts committed
121

122
123
defaultGlobalFlags :: GlobalFlags
defaultGlobalFlags  = GlobalFlags {
124
125
126
127
    globalVersion           = Flag False,
    globalNumericVersion    = Flag False,
    globalConfigFile        = mempty,
    globalSandboxConfigFile = mempty,
128
    globalRemoteRepos       = mempty,
129
130
131
    globalCacheDir          = mempty,
    globalLocalRepos        = mempty,
    globalLogsDir           = mempty,
132
    globalWorldFile         = mempty,
133
134
    globalRequireSandbox    = Flag False,
    globalIgnoreSandbox     = Flag False
135
136
137
138
139
140
  }

globalCommand :: CommandUI GlobalFlags
globalCommand = CommandUI {
    commandName         = "",
    commandSynopsis     = "",
141
142
143
144
    commandUsage        = \_ ->
         "This program is the command line interface "
           ++ "to the Haskell Cabal infrastructure.\n"
      ++ "See http://www.haskell.org/cabal/ for more information.\n",
145
    commandDescription  = Just $ \pname ->
146
147
148
149
150
151
         "For more information about a command use:\n"
      ++ "  " ++ pname ++ " COMMAND --help\n\n"
      ++ "To install Cabal packages from hackage use:\n"
      ++ "  " ++ pname ++ " install foo [--dry-run]\n\n"
      ++ "Occasionally you need to update the list of available packages:\n"
      ++ "  " ++ pname ++ " update\n",
152
    commandDefaultFlags = mempty,
153
    commandOptions      = \showOrParseArgs ->
154
      (case showOrParseArgs of ShowArgs -> take 6; ParseArgs -> id)
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
      [option ['V'] ["version"]
         "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")

170
171
172
173
174
175
      ,option [] ["sandbox-config-file"]
         "Set an alternate location for the sandbox config file \
         \(default: './cabal.sandbox.config')"
         globalConfigFile (\v flags -> flags { globalSandboxConfigFile = v })
         (reqArgFlag "FILE")

176
      ,option [] ["require-sandbox"]
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
177
         "requiring the presence of a sandbox for sandbox-aware commands"
178
179
180
         globalRequireSandbox (\v flags -> flags { globalRequireSandbox = v })
         (boolOpt' ([], ["require-sandbox"]) ([], ["no-require-sandbox"]))

181
182
183
184
185
      ,option [] ["ignore-sandbox"]
         "Ignore any existing sandbox"
         globalIgnoreSandbox (\v flags -> flags { globalIgnoreSandbox = v })
         trueArg

186
187
188
189
190
191
192
193
194
195
196
197
198
199
      ,option [] ["remote-repo"]
         "The name and url for a remote repository"
         globalRemoteRepos (\v flags -> flags { globalRemoteRepos = v })
         (reqArg' "NAME:URL" (maybeToList . readRepo) (map showRepo))

      ,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 })
         (reqArg' "DIR" (\x -> [x]) id)
200

201
202
203
204
205
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

206
207
208
209
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
210
211
212
213
214
      ]
  }

instance Monoid GlobalFlags where
  mempty = GlobalFlags {
215
216
217
218
219
220
221
222
    globalVersion           = mempty,
    globalNumericVersion    = mempty,
    globalConfigFile        = mempty,
    globalSandboxConfigFile = mempty,
    globalRemoteRepos       = mempty,
    globalCacheDir          = mempty,
    globalLocalRepos        = mempty,
    globalLogsDir           = mempty,
223
    globalWorldFile         = mempty,
224
225
    globalRequireSandbox    = mempty,
    globalIgnoreSandbox     = mempty
226
227
  }
  mappend a b = GlobalFlags {
228
229
230
231
232
233
234
235
    globalVersion           = combine globalVersion,
    globalNumericVersion    = combine globalNumericVersion,
    globalConfigFile        = combine globalConfigFile,
    globalSandboxConfigFile = combine globalConfigFile,
    globalRemoteRepos       = combine globalRemoteRepos,
    globalCacheDir          = combine globalCacheDir,
    globalLocalRepos        = combine globalLocalRepos,
    globalLogsDir           = combine globalLogsDir,
236
    globalWorldFile         = combine globalWorldFile,
237
238
    globalRequireSandbox    = combine globalRequireSandbox,
    globalIgnoreSandbox     = combine globalIgnoreSandbox
Duncan Coutts's avatar
Duncan Coutts committed
239
  }
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
    where combine field = field a `mappend` field b

globalRepos :: GlobalFlags -> [Repo]
globalRepos globalFlags = remoteRepos ++ localRepos
  where
    remoteRepos =
      [ Repo (Left remote) cacheDir
      | remote <- globalRemoteRepos globalFlags
      , let cacheDir = fromFlag (globalCacheDir globalFlags)
                   </> remoteRepoName remote ]
    localRepos =
      [ Repo (Right LocalRepo) local
      | local <- globalLocalRepos globalFlags ]

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

258
configureCommand :: CommandUI ConfigFlags
259
configureCommand = (Cabal.configureCommand defaultProgramConfiguration) {
260
    commandDefaultFlags = mempty
Duncan Coutts's avatar
Duncan Coutts committed
261
262
  }

263
264
265
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

266
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
267
filterConfigureFlags flags cabalLibVersion
268
  | cabalLibVersion >= Version [1,19,2] [] = flags_latest
269
270
271
  | cabalLibVersion <  Version [1,3,10] [] = flags_1_3_10
  | cabalLibVersion <  Version [1,10,0] [] = flags_1_10_0
  | cabalLibVersion <  Version [1,14,0] [] = flags_1_14_0
272
  | cabalLibVersion <  Version [1,18,0] [] = flags_1_18_0
273
  | cabalLibVersion <  Version [1,19,1] [] = flags_1_19_0
274
  | cabalLibVersion <  Version [1,19,2] [] = flags_1_19_1
275
  | otherwise = flags_latest
276
  where
277
    -- Cabal >= 1.19.1 uses '--dependency' and does not need '--constraint'.
278
279
    flags_latest = flags        { configConstraints = [] }

280
281
282
283
284
    -- Cabal < 1.19.2 doesn't know about '--exact-configuration'.
    flags_1_19_1 = flags_latest { configExactConfiguration = NoFlag }
    -- Cabal < 1.19.1 uses '--constraint' instead of '--dependency'.
    flags_1_19_0 = flags_1_19_1 { configDependencies = []
                                , configConstraints  = configConstraints flags }
285
    -- Cabal < 1.18.0 doesn't know about --extra-prog-path and --sysconfdir.
286
    flags_1_18_0 = flags_1_19_0 { configProgramPathExtra = []
287
288
                                , configInstallDirs = configInstallDirs_1_18_0}
    configInstallDirs_1_18_0 = (configInstallDirs flags) { sysconfdir = NoFlag }
289
    -- Cabal < 1.14.0 doesn't know about '--disable-benchmarks'.
290
    flags_1_14_0 = flags_1_18_0 { configBenchmarks  = NoFlag }
291
    -- Cabal < 1.10.0 doesn't know about '--disable-tests'.
292
    flags_1_10_0 = flags_1_14_0 { configTests       = NoFlag }
293
    -- Cabal < 1.3.10 does not grok the '--constraints' flag.
294
    flags_1_3_10 = flags_1_10_0 { configConstraints = [] }
295

296
297
298
299
300
301
302
303
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
304
    configExConstraints:: [UserConstraint],
305
    configPreferences  :: [Dependency],
306
307
    configSolver       :: Flag PreSolver,
    configAllowNewer   :: Flag AllowNewer
308
309
310
  }

defaultConfigExFlags :: ConfigExFlags
311
312
defaultConfigExFlags = mempty { configSolver     = Flag defaultSolver
                              , configAllowNewer = Flag AllowNewerNone }
313
314
315
316
317

configureExCommand :: CommandUI (ConfigFlags, ConfigExFlags)
configureExCommand = configureCommand {
    commandDefaultFlags = (mempty, defaultConfigExFlags),
    commandOptions      = \showOrParseArgs ->
318
         liftOptions fst setFst
319
         (filter ((`notElem` ["constraint", "dependency", "exact-configuration"])
320
                  . optionName) $ configureOptions  showOrParseArgs)
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
      ++ liftOptions snd setSnd (configureExOptions showOrParseArgs)
  }
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

configureExOptions ::  ShowOrParseArgs -> [OptionField ConfigExFlags]
configureExOptions _showOrParseArgs =
  [ 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))
336
337
338
339
340
341
  , option [] ["constraint"]
      "Specify constraints on a package (version, installed/source, flags)"
      configExConstraints (\v flags -> flags { configExConstraints = v })
      (reqArg "CONSTRAINT"
              (fmap (\x -> [x]) (ReadE readUserConstraint))
              (map display))
342
343
344
345

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
346
347
348
349
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
350
351

  , optionSolver configSolver (\v flags -> flags { configSolver = v })
352
353
354
355
356
357
358
359

  , option [] ["allow-newer"]
    "Ignore upper bounds in dependencies on some or all packages."
    configAllowNewer (\v flags -> flags { configAllowNewer = v})
    (optArg "PKGS"
     (fmap Flag allowNewerParser) (Flag AllowNewerAll)
     allowNewerPrinter)

360
361
362
363
364
  ]

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
365
    configExConstraints= mempty,
366
    configPreferences  = mempty,
367
368
    configSolver       = mempty,
    configAllowNewer   = mempty
369
370
371
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
372
    configExConstraints= combine configExConstraints,
373
    configPreferences  = combine configPreferences,
374
375
    configSolver       = combine configSolver,
    configAllowNewer   = combine configAllowNewer
376
377
378
  }
    where combine field = field a `mappend` field b

ttuegel's avatar
ttuegel committed
379
380
381
382
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

383
384
385
386
387
388
389
390
391
392
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
}

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
393
  option [] ["only"]
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
  "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

-- ------------------------------------------------------------
-- * Test command
-- ------------------------------------------------------------

428
testCommand :: CommandUI (TestFlags, BuildFlags, BuildExFlags)
429
testCommand = parent {
430
431
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
432
  commandOptions      =
433
    \showOrParseArgs -> liftOptions get1 set1
434
435
                        (commandOptions parent showOrParseArgs)
                        ++
436
437
438
439
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
440
441
  }
  where
442
443
444
    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)
445

446
447
    parent   = Cabal.testCommand
    progConf = defaultProgramConfiguration
448
449
450
451
452

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

453
benchmarkCommand :: CommandUI (BenchmarkFlags, BuildFlags, BuildExFlags)
454
benchmarkCommand = parent {
455
456
  commandDefaultFlags = (commandDefaultFlags parent,
                         Cabal.defaultBuildFlags, mempty),
457
  commandOptions      =
458
    \showOrParseArgs -> liftOptions get1 set1
459
460
                        (commandOptions parent showOrParseArgs)
                        ++
461
462
463
464
                        liftOptions get2 set2
                        (Cabal.buildOptions progConf showOrParseArgs)
                        ++
                        liftOptions get3 set3 (buildExOptions showOrParseArgs)
ttuegel's avatar
ttuegel committed
465
  }
466
  where
467
468
469
    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)
470

471
472
    parent   = Cabal.benchmarkCommand
    progConf = defaultProgramConfiguration
ttuegel's avatar
ttuegel committed
473

474
-- ------------------------------------------------------------
475
-- * Fetch command
476
-- ------------------------------------------------------------
477

478
479
480
481
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
482
      fetchSolver           :: Flag PreSolver,
483
484
485
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
486
      fetchShadowPkgs       :: Flag Bool,
487
488
489
490
491
492
493
494
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
495
496
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
497
    fetchReorderGoals     = Flag False,
498
    fetchIndependentGoals = Flag False,
499
    fetchShadowPkgs       = Flag False,
500
501
502
503
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
504
505
fetchCommand = CommandUI {
    commandName         = "fetch",
506
    commandSynopsis     = "Downloads packages for later installation.",
Duncan Coutts's avatar
Duncan Coutts committed
507
    commandDescription  = Nothing,
refold's avatar
refold committed
508
    commandUsage        = usagePackages "fetch",
509
    commandDefaultFlags = defaultFetchFlags,
510
    commandOptions      = \ showOrParseArgs -> [
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
         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
532
533
534
535

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
536
537
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
538
539
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
540
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
541

Duncan Coutts's avatar
Duncan Coutts committed
542
543
  }

544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
-- ------------------------------------------------------------
-- * Freeze command
-- ------------------------------------------------------------

data FreezeFlags = FreezeFlags {
      freezeDryRun           :: Flag Bool,
      freezeSolver           :: Flag PreSolver,
      freezeMaxBackjumps     :: Flag Int,
      freezeReorderGoals     :: Flag Bool,
      freezeIndependentGoals :: Flag Bool,
      freezeShadowPkgs       :: Flag Bool,
      freezeVerbosity        :: Flag Verbosity
    }

defaultFreezeFlags :: FreezeFlags
defaultFreezeFlags = FreezeFlags {
    freezeDryRun           = toFlag False,
    freezeSolver           = Flag defaultSolver,
    freezeMaxBackjumps     = Flag defaultMaxBackjumps,
563
    freezeReorderGoals     = Flag False,
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
    freezeIndependentGoals = Flag False,
    freezeShadowPkgs       = Flag False,
    freezeVerbosity        = toFlag normal
   }

freezeCommand :: CommandUI FreezeFlags
freezeCommand = CommandUI {
    commandName         = "freeze",
    commandSynopsis     = "Freeze dependencies.",
    commandDescription  = Nothing,
    commandUsage        = usagePackages "freeze",
    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

       ] ++

       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 })

  }

595
596
597
598
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

599
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
600
601
updateCommand = CommandUI {
    commandName         = "update",
602
    commandSynopsis     = "Updates list of known packages.",
Duncan Coutts's avatar
Duncan Coutts committed
603
    commandDescription  = Nothing,
refold's avatar
refold committed
604
    commandUsage        = usageFlags "update",
605
    commandDefaultFlags = toFlag normal,
606
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
607
608
  }

609
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
610
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
611
    commandName         = "upgrade",
612
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
613
    commandDescription  = Nothing,
refold's avatar
refold committed
614
    commandUsage        = usageFlagsOrPackages "upgrade",
615
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
616
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
617
618
  }

Duncan Coutts's avatar
Duncan Coutts committed
619
620
621
622
623
624
625
626
627
628
629
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

630
631
632
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
633
    commandSynopsis     = "Check the package for common mistakes.",
634
635
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
636
    commandDefaultFlags = toFlag normal,
637
    commandOptions      = \_ -> []
638
639
  }

640
641
642
643
644
645
646
647
648
649
formatCommand  :: CommandUI (Flag Verbosity)
formatCommand = CommandUI {
    commandName         = "format",
    commandSynopsis     = "Reformat the .cabal file using the standard style.",
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " format [FILE]\n",
    commandDefaultFlags = toFlag normal,
    commandOptions      = \_ -> []
  }

650
runCommand :: CommandUI (BuildFlags, BuildExFlags)
refold's avatar
refold committed
651
652
653
654
655
runCommand = CommandUI {
    commandName         = "run",
    commandSynopsis     = "Runs the compiled executable.",
    commandDescription  = Nothing,
    commandUsage        =
656
657
658
      \pname -> "Usage: " ++ pname
                ++ " run [FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]\n\n"
                ++ "Flags for run:",
refold's avatar
refold committed
659
    commandDefaultFlags = mempty,
660
661
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
662
                          (commandOptions parent showOrParseArgs)
663
664
665
                          ++
                          liftOptions snd setSnd
                          (buildExOptions showOrParseArgs)
refold's avatar
refold committed
666
667
  }
  where
668
669
670
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

671
    parent = Cabal.buildCommand defaultProgramConfiguration
refold's avatar
refold committed
672

673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
-- ------------------------------------------------------------
-- * 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
691
692
693
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
    commandDescription  = Just $ \_ ->
         "You can store your Hackage login in the ~/.cabal/config file\n",
    commandUsage        = \pname -> "Usage: " ++ pname ++ " report [FLAGS]\n\n"
      ++ "Flags for upload:",
    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))
      ]
714
715
  }

716
717
718
719
720
721
722
723
724
725
726
727
728
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

729
-- ------------------------------------------------------------
730
-- * Get flags
731
732
-- ------------------------------------------------------------

733
734
735
736
737
738
data GetFlags = GetFlags {
    getDestDir          :: Flag FilePath,
    getPristine         :: Flag Bool,
    getSourceRepository :: Flag (Maybe RepoKind),
    getVerbosity        :: Flag Verbosity
  }
739

740
741
742
743
744
745
defaultGetFlags :: GetFlags
defaultGetFlags = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = toFlag normal
746
747
   }

748
749
750
751
getCommand :: CommandUI GetFlags
getCommand = CommandUI {
    commandName         = "get",
    commandSynopsis     = "Gets a package's source code.",
752
753
754
755
756
    commandDescription  = Just $ \_ ->
          "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",
757
    commandUsage        = usagePackages "get",
758
    commandDefaultFlags = defaultGetFlags,
759
    commandOptions      = \_ -> [
760
        optionVerbosity getVerbosity (\v flags -> flags { getVerbosity = v })
761
762

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

767
       ,option "s" ["source-repository"]
768
         "Copy the package's source repository (ie git clone, darcs get, etc as appropriate)."
769
770
771
772
773
774
         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))

775
776
777
       , option [] ["pristine"]
           ("Unpack the original pristine tarball, rather than updating the "
           ++ ".cabal file with the latest revision from the package archive.")
778
           getPristine (\v flags -> flags { getPristine = v })
779
           trueArg
780
781
782
       ]
  }

783
784
785
786
787
788
789
-- 'cabal unpack' is a deprecated alias for 'cabal get'.
unpackCommand :: CommandUI GetFlags
unpackCommand = getCommand {
  commandName  = "unpack",
  commandUsage = usagePackages "unpack"
  }

790
instance Monoid GetFlags where
791
792
793
794
795
796
  mempty = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = mempty
    }
797
798
799
800
801
  mappend a b = GetFlags {
    getDestDir          = combine getDestDir,
    getPristine         = combine getPristine,
    getSourceRepository = combine getSourceRepository,
    getVerbosity        = combine getVerbosity
802
803
804
  }
    where combine field = field a `mappend` field b

805
806
807
808
809
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
810
    listInstalled    :: Flag Bool,
811
    listSimpleOutput :: Flag Bool,
812
813
    listVerbosity    :: Flag Verbosity,
    listPackageDBs   :: [Maybe PackageDB]
814
815
816
817
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
818
    listInstalled    = Flag False,
819
    listSimpleOutput = Flag False,
820
821
    listVerbosity    = toFlag normal,
    listPackageDBs   = []
822
823
824
825
826
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
827
    commandSynopsis     = "List packages matching a search string.",
828
    commandDescription  = Nothing,
refold's avatar
refold committed
829
    commandUsage        = usageFlagsOrPackages "list",
830
    commandDefaultFlags = defaultListFlags,
831
    commandOptions      = \_ -> [
832
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
833

834
        , option [] ["installed"]
835
836
837
838
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

839
840
841
842
843
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

844
845
846
847
848
        , option "" ["package-db"]
          "Use a given package database. May be a specific file, 'global', 'user' or 'clear'."
          listPackageDBs (\v flags -> flags { listPackageDBs = v })
          (reqArg' "DB" readPackageDbList showPackageDbList)

849
850
851
852
        ]
  }

instance Monoid ListFlags where
853
854
855
856
857
858
  mempty = ListFlags {
    listInstalled    = mempty,
    listSimpleOutput = mempty,
    listVerbosity    = mempty,
    listPackageDBs   = mempty
    }
859
  mappend a b = ListFlags {
860
    listInstalled    = combine listInstalled,
861
    listSimpleOutput = combine listSimpleOutput,
862
863
    listVerbosity    = combine listVerbosity,
    listPackageDBs   = combine listPackageDBs
864
865
866
  }
    where combine field = field a `mappend` field b

867
868
869
870
871
-- ------------------------------------------------------------
-- * Info flags
-- ------------------------------------------------------------

data InfoFlags = InfoFlags {
872
873
    infoVerbosity  :: Flag Verbosity,
    infoPackageDBs :: [Maybe PackageDB]
874
875
876
877
  }

defaultInfoFlags :: InfoFlags
defaultInfoFlags = InfoFlags {
878
879
    infoVerbosity  = toFlag normal,
    infoPackageDBs = []
880
881
882
883
884
885
886
  }

infoCommand  :: CommandUI InfoFlags
infoCommand = CommandUI {
    commandName         = "info",
    commandSynopsis     = "Display detailed information about a particular package.",
    commandDescription  = Nothing,
refold's avatar
refold committed
887
    commandUsage        = usagePackages "info",
888
889
890
    commandDefaultFlags = defaultInfoFlags,
    commandOptions      = \_ -> [
        optionVerbosity infoVerbosity (\v flags -> flags { infoVerbosity = v })
891
892
893
894
895
896

        , option "" ["package-db"]
          "Use a given package database. May be a specific file, 'global', 'user' or 'clear'."
          infoPackageDBs (\v flags -> flags { infoPackageDBs = v })
          (reqArg' "DB" readPackageDbList showPackageDbList)

897
898
899
900
        ]
  }

instance Monoid InfoFlags where
901
902
903
904
  mempty = InfoFlags {
    infoVerbosity  = mempty,
    infoPackageDBs = mempty
    }
905
  mappend a b = InfoFlags {
906
907
    infoVerbosity  = combine infoVerbosity,
    infoPackageDBs = combine infoPackageDBs
908
909
910
  }
    where combine field = field a `mappend` field b

911
912
913
914
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

915
916
-- | Install takes the same flags as configure along with a few extras.
--
917
data InstallFlags = InstallFlags {
918
919
920
    installDocumentation    :: Flag Bool,
    installHaddockIndex     :: Flag PathTemplate,
    installDryRun           :: Flag Bool,
921
922
923
    installMaxBackjumps     :: Flag Int,
    installReorderGoals     :: Flag Bool,
    installIndependentGoals :: Flag Bool,
924
    installShadowPkgs       :: Flag Bool,
925
926
    installReinstall        :: Flag Bool,
    installAvoidReinstalls  :: Flag Bool,
927
    installOverrideReinstall :: Flag Bool,
928
929
930
931
932
933
934
935
    installUpgradeDeps      :: Flag Bool,
    installOnly             :: Flag Bool,
    installOnlyDeps         :: Flag Bool,
    installRootCmd          :: Flag String,
    installSummaryFile      :: [PathTemplate],
    installLogFile          :: Flag PathTemplate,
    installBuildReports     :: Flag ReportLevel,
    installSymlinkBinDir    :: Flag FilePath,
936
    installOneShot          :: Flag Bool,
937
938
    installNumJobs          :: Flag (Maybe Int),
    installRunTests         :: Flag Bool
939
940
941
942
  }

defaultInstallFlags :: InstallFlags
defaultInstallFlags = InstallFlags {
943
944
945
    installDocumentation   = Flag False,
    installHaddockIndex    = Flag docIndexFile,
    installDryRun          = Flag False,
946
    installMaxBackjumps    = Flag defaultMaxBackjumps,
947
    installReorderGoals    = Flag False,
948
    installIndependentGoals= Flag False,
949
    installShadowPkgs      = Flag False,
950
951
    installReinstall       = Flag False,
    installAvoidReinstalls = Flag False,
952
    installOverrideReinstall = Flag False,
953
954
955
956
957
958
959
960
    installUpgradeDeps     = Flag False,
    installOnly            = Flag False,
    installOnlyDeps        = Flag False,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = Flag NoReports,
    installSymlinkBinDir   = mempty,
961
    installOneShot         = Flag False,
962
963
    installNumJobs         = mempty,
    installRunTests        = mempty
964
  }
965
966
  where
    docIndexFile = toPathTemplate ("$datadir" </> "doc" </> "index.html")
967

968
969
970
971
972
973
974
975
976
977
978
979
980
allowNewerParser :: ReadE AllowNewer
allowNewerParser = ReadE $ \s ->
  case s of
    ""      -> Right AllowNewerNone
    "False" -> Right AllowNewerNone
    "True"  -> Right AllowNewerAll
    _       ->
      case readPToMaybe pkgsParser s of
        Just pkgs -> Right . AllowNewerSome $ pkgs
        Nothing   -> Left ("Cannot parse the list of packages: " ++ s)
  where
    pkgsParser = Parse.sepBy1 parse (Parse.char ',')

981
982
983
984
985
986
987
988
allowNewerPrinter :: Flag AllowNewer -> [Maybe String]
allowNewerPrinter (Flag AllowNewerNone)        = [Just "False"]
allowNewerPrinter (Flag AllowNewerAll)         = [Just "True"]
allowNewerPrinter (Flag (AllowNewerSome pkgs)) =
  [Just . intercalate "," . map display $ pkgs]
allowNewerPrinter NoFlag                       = []


989
defaultMaxBackjumps :: Int
990
defaultMaxBackjumps = 2000
991

992
993
defaultSolver :: PreSolver
defaultSolver = Choose
994
995

allSolvers :: String
996
allSolvers = intercalate ", " (map display ([minBound .. maxBound] :: [PreSolver]))
997

998
installCommand :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
999
installCommand = CommandUI {
1000
  commandName         = "install",