Setup.hs 63.8 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
    , uploadCommand, UploadFlags(..)
30
    , reportCommand, ReportFlags(..)
refold's avatar
refold committed
31
    , runCommand
32
    , initCommand, IT.InitFlags(..)
33
    , sdistCommand, SDistFlags(..), SDistExFlags(..), ArchiveFormat(..)
34
    , win32SelfUpgradeCommand, Win32SelfUpgradeFlags(..)
refold's avatar
refold committed
35
    , sandboxCommand, defaultSandboxLocation, SandboxFlags(..)
Duncan Coutts's avatar
Duncan Coutts committed
36
37

    , parsePackageArgs
38
39
40
    --TODO: stop exporting these:
    , showRepo
    , parseRepo
41
42
    ) where

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

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

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

101
102
103
104
105
106
-- ------------------------------------------------------------
-- * Global flags
-- ------------------------------------------------------------

-- | Flags that apply at the top level, not to any sub-command.
data GlobalFlags = GlobalFlags {
107
108
109
110
111
112
113
114
    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,
115
    globalWorldFile         :: Flag FilePath,
116
117
    globalRequireSandbox    :: Flag Bool,
    globalIgnoreSandbox     :: Flag Bool
118
  }
Duncan Coutts's avatar
Duncan Coutts committed
119

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

globalCommand :: CommandUI GlobalFlags
globalCommand = CommandUI {
    commandName         = "",
    commandSynopsis     = "",
139
140
141
142
    commandUsage        = \_ ->
         "This program is the command line interface "
           ++ "to the Haskell Cabal infrastructure.\n"
      ++ "See http://www.haskell.org/cabal/ for more information.\n",
143
    commandDescription  = Just $ \pname ->
144
145
146
147
148
149
         "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",
150
    commandDefaultFlags = mempty,
151
    commandOptions      = \showOrParseArgs ->
152
      (case showOrParseArgs of ShowArgs -> take 6; ParseArgs -> id)
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
      [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")

168
169
170
171
172
173
      ,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")

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

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

184
185
186
187
188
189
190
191
192
193
194
195
196
197
      ,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)
198

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

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

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

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

261
262
263
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

264
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
265
filterConfigureFlags flags cabalLibVersion
266
  | cabalLibVersion >= Version [1,19,2] [] = flags_latest
267
268
269
  | 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
270
  | cabalLibVersion <  Version [1,18,0] [] = flags_1_18_0
271
  | cabalLibVersion <  Version [1,19,1] [] = flags_1_19_0
272
  | cabalLibVersion <  Version [1,19,2] [] = flags_1_19_1
273
  | otherwise = flags_latest
274
  where
275
    -- Cabal >= 1.19.1 uses '--dependency' and does not need '--constraint'.
276
277
    flags_latest = flags        { configConstraints = [] }

278
279
280
281
282
    -- 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 }
283
    -- Cabal < 1.18.0 doesn't know about --extra-prog-path and --sysconfdir.
284
    flags_1_18_0 = flags_1_19_0 { configProgramPathExtra = []
285
286
                                , configInstallDirs = configInstallDirs_1_18_0}
    configInstallDirs_1_18_0 = (configInstallDirs flags) { sysconfdir = NoFlag }
287
    -- Cabal < 1.14.0 doesn't know about '--disable-benchmarks'.
288
    flags_1_14_0 = flags_1_18_0 { configBenchmarks  = NoFlag }
289
    -- Cabal < 1.10.0 doesn't know about '--disable-tests'.
290
    flags_1_10_0 = flags_1_14_0 { configTests       = NoFlag }
291
    -- Cabal < 1.3.10 does not grok the '--constraints' flag.
292
    flags_1_3_10 = flags_1_10_0 { configConstraints = [] }
293

294
295
296
297
298
299
300
301
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

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

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

configureExCommand :: CommandUI (ConfigFlags, ConfigExFlags)
configureExCommand = configureCommand {
    commandDefaultFlags = (mempty, defaultConfigExFlags),
    commandOptions      = \showOrParseArgs ->
316
         liftOptions fst setFst
317
         (filter ((`notElem` ["constraint", "dependency", "exact-configuration"])
318
                  . optionName) $ configureOptions  showOrParseArgs)
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
      ++ 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))
334
335
336
337
338
339
  , 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))
340
341
342
343

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

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

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

358
359
360
361
362
  ]

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

ttuegel's avatar
ttuegel committed
377
378
379
380
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

381
382
383
384
385
386
387
388
389
390
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildOnly     :: Flag SkipAddSourceDepsCheck
}

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
391
  option [] ["only"]
392
393
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
  "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
-- ------------------------------------------------------------

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

444
445
    parent   = Cabal.testCommand
    progConf = defaultProgramConfiguration
446
447
448
449
450

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

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

469
470
    parent   = Cabal.benchmarkCommand
    progConf = defaultProgramConfiguration
ttuegel's avatar
ttuegel committed
471

472
-- ------------------------------------------------------------
473
-- * Fetch command
474
-- ------------------------------------------------------------
475

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

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

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

       ] ++

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

Duncan Coutts's avatar
Duncan Coutts committed
540
541
  }

542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
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
-- ------------------------------------------------------------
-- * 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,
    freezeReorderGoals     = Flag False,
    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 })

  }

593
594
595
596
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

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

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

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

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

638
runCommand :: CommandUI (BuildFlags, BuildExFlags)
refold's avatar
refold committed
639
640
641
642
643
runCommand = CommandUI {
    commandName         = "run",
    commandSynopsis     = "Runs the compiled executable.",
    commandDescription  = Nothing,
    commandUsage        =
644
645
646
      \pname -> "Usage: " ++ pname
                ++ " run [FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]\n\n"
                ++ "Flags for run:",
refold's avatar
refold committed
647
    commandDefaultFlags = mempty,
648
649
650
651
652
653
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
                          (Cabal.buildOptions progConf showOrParseArgs)
                          ++
                          liftOptions snd setSnd
                          (buildExOptions showOrParseArgs)
refold's avatar
refold committed
654
655
  }
  where
656
657
658
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

refold's avatar
refold committed
659
660
    progConf = defaultProgramConfiguration

661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
-- ------------------------------------------------------------
-- * 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
679
680
681
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
    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))
      ]
702
703
  }

704
705
706
707
708
709
710
711
712
713
714
715
716
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

717
-- ------------------------------------------------------------
718
-- * Get flags
719
720
-- ------------------------------------------------------------

721
722
723
724
725
726
data GetFlags = GetFlags {
    getDestDir          :: Flag FilePath,
    getPristine         :: Flag Bool,
    getSourceRepository :: Flag (Maybe RepoKind),
    getVerbosity        :: Flag Verbosity
  }
727

728
729
730
731
732
733
defaultGetFlags :: GetFlags
defaultGetFlags = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = toFlag normal
734
735
   }

736
737
738
739
getCommand :: CommandUI GetFlags
getCommand = CommandUI {
    commandName         = "get",
    commandSynopsis     = "Gets a package's source code.",
740
741
742
743
744
    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",
745
    commandUsage        = usagePackages "get",
746
    commandDefaultFlags = defaultGetFlags,
747
    commandOptions      = \_ -> [
748
        optionVerbosity getVerbosity (\v flags -> flags { getVerbosity = v })
749
750

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

755
       ,option "s" ["source-repository"]
756
         "Copy the package's source repository (ie git clone, darcs get, etc as appropriate)."
757
758
759
760
761
762
         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))

763
764
765
       , option [] ["pristine"]
           ("Unpack the original pristine tarball, rather than updating the "
           ++ ".cabal file with the latest revision from the package archive.")
766
           getPristine (\v flags -> flags { getPristine = v })
767
           trueArg
768
769
770
       ]
  }

771
772
773
774
775
776
777
-- 'cabal unpack' is a deprecated alias for 'cabal get'.
unpackCommand :: CommandUI GetFlags
unpackCommand = getCommand {
  commandName  = "unpack",
  commandUsage = usagePackages "unpack"
  }

778
instance Monoid GetFlags where
779
780
781
782
783
784
  mempty = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = mempty
    }
785
786
787
788
789
  mappend a b = GetFlags {
    getDestDir          = combine getDestDir,
    getPristine         = combine getPristine,
    getSourceRepository = combine getSourceRepository,
    getVerbosity        = combine getVerbosity
790
791
792
  }
    where combine field = field a `mappend` field b

793
794
795
796
797
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
798
    listInstalled    :: Flag Bool,
799
    listSimpleOutput :: Flag Bool,
800
801
    listVerbosity    :: Flag Verbosity,
    listPackageDBs   :: [Maybe PackageDB]
802
803
804
805
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
806
    listInstalled    = Flag False,
807
    listSimpleOutput = Flag False,
808
809
    listVerbosity    = toFlag normal,
    listPackageDBs   = []
810
811
812
813
814
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
815
    commandSynopsis     = "List packages matching a search string.",
816
    commandDescription  = Nothing,
refold's avatar
refold committed
817
    commandUsage        = usageFlagsOrPackages "list",
818
    commandDefaultFlags = defaultListFlags,
819
    commandOptions      = \_ -> [
820
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
821

822
        , option [] ["installed"]
823
824
825
826
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

827
828
829
830
831
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

832
833
834
835
836
        , 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)

837
838
839
840
        ]
  }

instance Monoid ListFlags where
841
842
843
844
845
846
  mempty = ListFlags {
    listInstalled    = mempty,
    listSimpleOutput = mempty,
    listVerbosity    = mempty,
    listPackageDBs   = mempty
    }
847
  mappend a b = ListFlags {
848
    listInstalled    = combine listInstalled,
849
    listSimpleOutput = combine listSimpleOutput,
850
851
    listVerbosity    = combine listVerbosity,
    listPackageDBs   = combine listPackageDBs
852
853
854
  }
    where combine field = field a `mappend` field b

855
856
857
858
859
-- ------------------------------------------------------------
-- * Info flags
-- ------------------------------------------------------------

data InfoFlags = InfoFlags {
860
861
    infoVerbosity  :: Flag Verbosity,
    infoPackageDBs :: [Maybe PackageDB]
862
863
864
865
  }

defaultInfoFlags :: InfoFlags
defaultInfoFlags = InfoFlags {
866
867
    infoVerbosity  = toFlag normal,
    infoPackageDBs = []
868
869
870
871
872
873
874
  }

infoCommand  :: CommandUI InfoFlags
infoCommand = CommandUI {
    commandName         = "info",
    commandSynopsis     = "Display detailed information about a particular package.",
    commandDescription  = Nothing,
refold's avatar
refold committed
875
    commandUsage        = usagePackages "info",
876
877
878
    commandDefaultFlags = defaultInfoFlags,
    commandOptions      = \_ -> [
        optionVerbosity infoVerbosity (\v flags -> flags { infoVerbosity = v })
879
880
881
882
883
884

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

885
886
887
888
        ]
  }

instance Monoid InfoFlags where
889
890
891
892
  mempty = InfoFlags {
    infoVerbosity  = mempty,
    infoPackageDBs = mempty
    }
893
  mappend a b = InfoFlags {
894
895
    infoVerbosity  = combine infoVerbosity,
    infoPackageDBs = combine infoPackageDBs
896
897
898
  }
    where combine field = field a `mappend` field b

899
900
901
902
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

903
904
-- | Install takes the same flags as configure along with a few extras.
--
905
data InstallFlags = InstallFlags {
906
907
908
    installDocumentation    :: Flag Bool,
    installHaddockIndex     :: Flag PathTemplate,
    installDryRun           :: Flag Bool,
909
910
911
    installMaxBackjumps     :: Flag Int,
    installReorderGoals     :: Flag Bool,
    installIndependentGoals :: Flag Bool,
912
    installShadowPkgs       :: Flag Bool,
913
914
    installReinstall        :: Flag Bool,
    installAvoidReinstalls  :: Flag Bool,
915
    installOverrideReinstall :: Flag Bool,
916
917
918
919
920
921
922
923
    installUpgradeDeps      :: Flag Bool,
    installOnly             :: Flag Bool,
    installOnlyDeps         :: Flag Bool,
    installRootCmd          :: Flag String,
    installSummaryFile      :: [PathTemplate],
    installLogFile          :: Flag PathTemplate,
    installBuildReports     :: Flag ReportLevel,
    installSymlinkBinDir    :: Flag FilePath,
924
    installOneShot          :: Flag Bool,
925
    installNumJobs          :: Flag (Maybe Int)
926
927
928
929
  }

defaultInstallFlags :: InstallFlags
defaultInstallFlags = InstallFlags {
930
931
932
    installDocumentation   = Flag False,
    installHaddockIndex    = Flag docIndexFile,
    installDryRun          = Flag False,
933
934
935
    installMaxBackjumps    = Flag defaultMaxBackjumps,
    installReorderGoals    = Flag False,
    installIndependentGoals= Flag False,
936
    installShadowPkgs      = Flag False,
937
938
    installReinstall       = Flag False,
    installAvoidReinstalls = Flag False,
939
    installOverrideReinstall = Flag False,
940
941
942
943
944
945
946
947
    installUpgradeDeps     = Flag False,
    installOnly            = Flag False,
    installOnlyDeps        = Flag False,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = Flag NoReports,
    installSymlinkBinDir   = mempty,
948
    installOneShot         = Flag False,
949
    installNumJobs         = mempty
950
  }
951
952
  where
    docIndexFile = toPathTemplate ("$datadir" </> "doc" </> "index.html")
953

954
955
956
957
958
959
960
961
962
963
964
965
966
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 ',')

967
968
969
970
971
972
973
974
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                       = []


975
976
977
defaultMaxBackjumps :: Int
defaultMaxBackjumps = 200

978
979
defaultSolver :: PreSolver
defaultSolver = Choose
980
981

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

984
installCommand :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
985
installCommand = CommandUI {
986
987
  commandName         = "install",
  commandSynopsis     = "Installs a list of packages.",
refold's avatar
refold committed
988
  commandUsage        = usageFlagsOrPackages "install",
989
990
991
992
993
  commandDescription  = Just $ \pname ->
    let original = case commandDescription configureCommand of
          Just desc -> desc pname ++ "\n"
          Nothing   -> ""
     in original
994
     ++ "Examples:\n"
995
996
997
998
999
1000
     ++ "  " ++ pname ++ " install                 "
     ++ "    Package in the current directory\n"
     ++ "  " ++ pname ++ " install foo             "
     ++ "    Package from the hackage server\n"
     ++ "  " ++ pname ++ " install foo-1.0         "
     ++ "    Specific version of a package\n"