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

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

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

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

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

97
98
99
100
101
102
-- ------------------------------------------------------------
-- * Global flags
-- ------------------------------------------------------------

-- | Flags that apply at the top level, not to any sub-command.
data GlobalFlags = GlobalFlags {
103
104
105
106
107
108
109
110
111
    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,
    globalWorldFile         :: Flag FilePath
112
  }
Duncan Coutts's avatar
Duncan Coutts committed
113

114
115
defaultGlobalFlags :: GlobalFlags
defaultGlobalFlags  = GlobalFlags {
116
117
118
119
120
121
122
123
124
    globalVersion           = Flag False,
    globalNumericVersion    = Flag False,
    globalConfigFile        = mempty,
    globalSandboxConfigFile = mempty,
    globalRemoteRepos       = [],
    globalCacheDir          = mempty,
    globalLocalRepos        = mempty,
    globalLogsDir           = mempty,
    globalWorldFile         = mempty
125
126
127
128
129
130
  }

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

160
161
162
163
164
165
      ,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")

166
167
168
169
170
171
172
173
174
175
176
177
178
179
      ,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)
180

181
182
183
184
185
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

186
187
188
189
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
190
191
192
193
194
      ]
  }

instance Monoid GlobalFlags where
  mempty = GlobalFlags {
195
196
197
198
199
200
201
202
203
    globalVersion           = mempty,
    globalNumericVersion    = mempty,
    globalConfigFile        = mempty,
    globalSandboxConfigFile = mempty,
    globalRemoteRepos       = mempty,
    globalCacheDir          = mempty,
    globalLocalRepos        = mempty,
    globalLogsDir           = mempty,
    globalWorldFile         = mempty
204
205
  }
  mappend a b = GlobalFlags {
206
207
208
209
210
211
212
213
214
    globalVersion           = combine globalVersion,
    globalNumericVersion    = combine globalNumericVersion,
    globalConfigFile        = combine globalConfigFile,
    globalSandboxConfigFile = combine globalConfigFile,
    globalRemoteRepos       = combine globalRemoteRepos,
    globalCacheDir          = combine globalCacheDir,
    globalLocalRepos        = combine globalLocalRepos,
    globalLogsDir           = combine globalLogsDir,
    globalWorldFile         = combine globalWorldFile
Duncan Coutts's avatar
Duncan Coutts committed
215
  }
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
    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
233

234
configureCommand :: CommandUI ConfigFlags
235
configureCommand = (Cabal.configureCommand defaultProgramConfiguration) {
236
    commandDefaultFlags = mempty
Duncan Coutts's avatar
Duncan Coutts committed
237
238
  }

239
240
241
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

242
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
243
filterConfigureFlags flags cabalLibVersion
244
  | cabalLibVersion >= Version [1,19,1] [] = flags_latest
245
246
247
  | 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
248
  | cabalLibVersion <  Version [1,18,0] [] = flags_1_18_0
249
  | cabalLibVersion <  Version [1,19,1] [] = flags_1_19_0
250
  | otherwise = flags_latest
251
  where
252
253
254
    -- Cabal >= 1.19.1 uses --dependency and does not need --constraint
    flags_latest = flags        { configConstraints = [] }

255
    -- Cabal < 1.19.1 does not grok the --dependency flag.
256
    flags_1_19_0 = flags        { configDependencies = [] }
257
    -- Cabal < 1.18.0 doesn't know about --extra-prog-path and --sysconfdir.
258
    flags_1_18_0 = flags_1_19_0 { configProgramPathExtra = []
259
260
                                , configInstallDirs = configInstallDirs_1_18_0}
    configInstallDirs_1_18_0 = (configInstallDirs flags) { sysconfdir = NoFlag }
261
    -- Cabal < 1.14.0 doesn't know about --disable-benchmarks.
262
    flags_1_14_0 = flags_1_18_0 { configBenchmarks  = NoFlag }
263
264
    -- Cabal < 1.10.0 doesn't know about --disable-tests.
    flags_1_10_0 = flags_1_14_0 { configTests       = NoFlag }
265
    -- Cabal < 1.3.10 does not grok the --constraints flag.
266
    flags_1_3_10 = flags_1_10_0 { configConstraints = [] }
267

268
269
270
271
272
273
274
275
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
276
    configExConstraints:: [UserConstraint],
277
    configPreferences  :: [Dependency],
278
    configSolver       :: Flag PreSolver
279
280
281
  }

defaultConfigExFlags :: ConfigExFlags
282
defaultConfigExFlags = mempty { configSolver = Flag defaultSolver }
283
284
285
286
287

configureExCommand :: CommandUI (ConfigFlags, ConfigExFlags)
configureExCommand = configureCommand {
    commandDefaultFlags = (mempty, defaultConfigExFlags),
    commandOptions      = \showOrParseArgs ->
288
289
         liftOptions fst setFst (filter ((/="constraint") . optionName) $
                                 configureOptions   showOrParseArgs)
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
      ++ 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))
305
306
307
308
309
310
  , 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))
311
312
313
314

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
315
316
317
318
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
319
320

  , optionSolver configSolver (\v flags -> flags { configSolver = v })
321
322
323
324
325
  ]

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
326
    configExConstraints= mempty,
327
328
    configPreferences  = mempty,
    configSolver       = mempty
329
330
331
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
332
    configExConstraints= combine configExConstraints,
333
334
    configPreferences  = combine configPreferences,
    configSolver       = combine configSolver
335
336
337
  }
    where combine field = field a `mappend` field b

ttuegel's avatar
ttuegel committed
338
339
340
341
-- ------------------------------------------------------------
-- * Build flags
-- ------------------------------------------------------------

342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
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
data SkipAddSourceDepsCheck =
  SkipAddSourceDepsCheck | DontSkipAddSourceDepsCheck
  deriving Eq

data BuildExFlags = BuildExFlags {
  buildNumJobs  :: Flag (Maybe Int),
  buildOnly     :: Flag SkipAddSourceDepsCheck
}

buildExOptions :: ShowOrParseArgs -> [OptionField BuildExFlags]
buildExOptions _showOrParseArgs =
  option "j" ["jobs"]
  "Run NUM jobs simultaneously (or '$ncpus' if no NUM is given)"
  buildNumJobs (\v flags -> flags { buildNumJobs = v })
  (optArg "NUM" (fmap Flag numJobsParser)
   (Flag Nothing)
   (map (Just . maybe "$ncpus" show) . flagToList))

  : option [] ["only"]
  "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 {
    buildNumJobs = mempty,
    buildOnly    = mempty
  }
  mappend a b = BuildExFlags {
    buildNumJobs = combine buildNumJobs,
    buildOnly    = combine buildOnly
  }
    where combine field = field a `mappend` field b

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

testCommand :: CommandUI (TestFlags, BuildExFlags)
testCommand = 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.testCommand

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

benchmarkCommand :: CommandUI (BenchmarkFlags, BuildExFlags)
benchmarkCommand = parent {
  commandDefaultFlags = (commandDefaultFlags parent, mempty),
  commandOptions      =
    \showOrParseArgs -> liftOptions fst setFst
                        (commandOptions parent showOrParseArgs)
                        ++
                        liftOptions snd setSnd (buildExOptions showOrParseArgs)
ttuegel's avatar
ttuegel committed
424
  }
425
426
427
428
429
  where
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

    parent = Cabal.benchmarkCommand
ttuegel's avatar
ttuegel committed
430

431
-- ------------------------------------------------------------
432
-- * Fetch command
433
-- ------------------------------------------------------------
434

435
436
437
438
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
439
      fetchSolver           :: Flag PreSolver,
440
441
442
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
443
      fetchShadowPkgs       :: Flag Bool,
444
445
446
447
448
449
450
451
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
452
453
454
455
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
    fetchReorderGoals     = Flag False,
    fetchIndependentGoals = Flag False,
456
    fetchShadowPkgs       = Flag False,
457
458
459
460
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
461
462
fetchCommand = CommandUI {
    commandName         = "fetch",
463
    commandSynopsis     = "Downloads packages for later installation.",
Duncan Coutts's avatar
Duncan Coutts committed
464
    commandDescription  = Nothing,
refold's avatar
refold committed
465
    commandUsage        = usagePackages "fetch",
466
    commandDefaultFlags = defaultFetchFlags,
467
    commandOptions      = \ showOrParseArgs -> [
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
         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
489
490
491
492

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
493
494
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
495
496
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
497
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
498

Duncan Coutts's avatar
Duncan Coutts committed
499
500
  }

501
502
503
504
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

505
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
506
507
updateCommand = CommandUI {
    commandName         = "update",
508
    commandSynopsis     = "Updates list of known packages.",
Duncan Coutts's avatar
Duncan Coutts committed
509
    commandDescription  = Nothing,
refold's avatar
refold committed
510
    commandUsage        = usageFlags "update",
511
    commandDefaultFlags = toFlag normal,
512
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
513
514
  }

515
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
516
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
517
    commandName         = "upgrade",
518
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
519
    commandDescription  = Nothing,
refold's avatar
refold committed
520
    commandUsage        = usageFlagsOrPackages "upgrade",
521
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
522
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
523
524
  }

Duncan Coutts's avatar
Duncan Coutts committed
525
526
527
528
529
530
531
532
533
534
535
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

536
537
538
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
539
    commandSynopsis     = "Check the package for common mistakes.",
540
541
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
542
    commandDefaultFlags = toFlag normal,
543
    commandOptions      = \_ -> []
544
545
  }

546
runCommand :: CommandUI (BuildFlags, BuildExFlags)
refold's avatar
refold committed
547
548
549
550
551
runCommand = CommandUI {
    commandName         = "run",
    commandSynopsis     = "Runs the compiled executable.",
    commandDescription  = Nothing,
    commandUsage        =
552
553
554
      \pname -> "Usage: " ++ pname
                ++ " run [FLAGS] [EXECUTABLE] [-- EXECUTABLE_FLAGS]\n\n"
                ++ "Flags for run:",
refold's avatar
refold committed
555
    commandDefaultFlags = mempty,
556
557
558
559
560
561
    commandOptions      =
      \showOrParseArgs -> liftOptions fst setFst
                          (Cabal.buildOptions progConf showOrParseArgs)
                          ++
                          liftOptions snd setSnd
                          (buildExOptions showOrParseArgs)
refold's avatar
refold committed
562
563
  }
  where
564
565
566
    setFst a (_,b) = (a,b)
    setSnd b (a,_) = (a,b)

refold's avatar
refold committed
567
568
    progConf = defaultProgramConfiguration

569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
-- ------------------------------------------------------------
-- * 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
587
588
589
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
    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))
      ]
610
611
  }

612
613
614
615
616
617
618
619
620
621
622
623
624
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

625
-- ------------------------------------------------------------
626
-- * Get flags
627
628
-- ------------------------------------------------------------

629
630
631
632
633
634
data GetFlags = GetFlags {
    getDestDir          :: Flag FilePath,
    getPristine         :: Flag Bool,
    getSourceRepository :: Flag (Maybe RepoKind),
    getVerbosity        :: Flag Verbosity
  }
635

636
637
638
639
640
641
defaultGetFlags :: GetFlags
defaultGetFlags = GetFlags {
    getDestDir          = mempty,
    getPristine         = mempty,
    getSourceRepository = mempty,
    getVerbosity        = toFlag normal
642
643
   }

644
645
646
647
getCommand :: CommandUI GetFlags
getCommand = CommandUI {
    commandName         = "get",
    commandSynopsis     = "Gets a package's source code.",
648
649
650
651
652
    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",
653
    commandUsage        = usagePackages "get",
654
655
    commandDefaultFlags = mempty,
    commandOptions      = \_ -> [
656
        optionVerbosity getVerbosity (\v flags -> flags { getVerbosity = v })
657
658

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

663
       ,option "s" ["source-repository"]
664
         "Copy the package's source repository (ie git clone, darcs get, etc as appropriate)."
665
666
667
668
669
670
         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))

671
672
673
       , option [] ["pristine"]
           ("Unpack the original pristine tarball, rather than updating the "
           ++ ".cabal file with the latest revision from the package archive.")
674
           getPristine (\v flags -> flags { getPristine = v })
675
           trueArg
676
677
678
       ]
  }

679
680
681
682
683
684
685
-- 'cabal unpack' is a deprecated alias for 'cabal get'.
unpackCommand :: CommandUI GetFlags
unpackCommand = getCommand {
  commandName  = "unpack",
  commandUsage = usagePackages "unpack"
  }

686
687
688
689
690
691
692
instance Monoid GetFlags where
  mempty = defaultGetFlags
  mappend a b = GetFlags {
    getDestDir          = combine getDestDir,
    getPristine         = combine getPristine,
    getSourceRepository = combine getSourceRepository,
    getVerbosity        = combine getVerbosity
693
694
695
  }
    where combine field = field a `mappend` field b

696
697
698
699
700
701
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
    listInstalled :: Flag Bool,
702
    listSimpleOutput :: Flag Bool,
703
704
705
706
707
708
    listVerbosity :: Flag Verbosity
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
    listInstalled = Flag False,
709
    listSimpleOutput = Flag False,
710
711
712
713
714
715
    listVerbosity = toFlag normal
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
716
    commandSynopsis     = "List packages matching a search string.",
717
    commandDescription  = Nothing,
refold's avatar
refold committed
718
    commandUsage        = usageFlagsOrPackages "list",
719
    commandDefaultFlags = defaultListFlags,
720
    commandOptions      = \_ -> [
721
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
722

723
        , option [] ["installed"]
724
725
726
727
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

728
729
730
731
732
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

733
734
735
736
737
738
739
        ]
  }

instance Monoid ListFlags where
  mempty = defaultListFlags
  mappend a b = ListFlags {
    listInstalled = combine listInstalled,
740
    listSimpleOutput = combine listSimpleOutput,
741
742
743
744
    listVerbosity = combine listVerbosity
  }
    where combine field = field a `mappend` field b

745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
-- ------------------------------------------------------------
-- * Info flags
-- ------------------------------------------------------------

data InfoFlags = InfoFlags {
    infoVerbosity :: Flag Verbosity
  }

defaultInfoFlags :: InfoFlags
defaultInfoFlags = InfoFlags {
    infoVerbosity = toFlag normal
  }

infoCommand  :: CommandUI InfoFlags
infoCommand = CommandUI {
    commandName         = "info",
    commandSynopsis     = "Display detailed information about a particular package.",
    commandDescription  = Nothing,
refold's avatar
refold committed
763
    commandUsage        = usagePackages "info",
764
765
766
767
768
769
770
771
772
773
774
775
776
    commandDefaultFlags = defaultInfoFlags,
    commandOptions      = \_ -> [
        optionVerbosity infoVerbosity (\v flags -> flags { infoVerbosity = v })
        ]
  }

instance Monoid InfoFlags where
  mempty = defaultInfoFlags
  mappend a b = InfoFlags {
    infoVerbosity = combine infoVerbosity
  }
    where combine field = field a `mappend` field b

777
778
779
780
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

781
782
-- | Install takes the same flags as configure along with a few extras.
--
783
data InstallFlags = InstallFlags {
784
785
786
    installDocumentation    :: Flag Bool,
    installHaddockIndex     :: Flag PathTemplate,
    installDryRun           :: Flag Bool,
787
788
789
    installMaxBackjumps     :: Flag Int,
    installReorderGoals     :: Flag Bool,
    installIndependentGoals :: Flag Bool,
790
    installShadowPkgs       :: Flag Bool,
791
792
    installReinstall        :: Flag Bool,
    installAvoidReinstalls  :: Flag Bool,
793
    installOverrideReinstall :: Flag Bool,
794
795
796
797
798
799
800
801
    installUpgradeDeps      :: Flag Bool,
    installOnly             :: Flag Bool,
    installOnlyDeps         :: Flag Bool,
    installRootCmd          :: Flag String,
    installSummaryFile      :: [PathTemplate],
    installLogFile          :: Flag PathTemplate,
    installBuildReports     :: Flag ReportLevel,
    installSymlinkBinDir    :: Flag FilePath,
802
    installOneShot          :: Flag Bool,
803
    installNumJobs          :: Flag (Maybe Int)
804
805
806
807
  }

defaultInstallFlags :: InstallFlags
defaultInstallFlags = InstallFlags {
808
809
810
    installDocumentation   = Flag False,
    installHaddockIndex    = Flag docIndexFile,
    installDryRun          = Flag False,
811
812
813
    installMaxBackjumps    = Flag defaultMaxBackjumps,
    installReorderGoals    = Flag False,
    installIndependentGoals= Flag False,
814
    installShadowPkgs      = Flag False,
815
816
    installReinstall       = Flag False,
    installAvoidReinstalls = Flag False,
817
    installOverrideReinstall = Flag False,
818
819
820
821
822
823
824
825
    installUpgradeDeps     = Flag False,
    installOnly            = Flag False,
    installOnlyDeps        = Flag False,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = Flag NoReports,
    installSymlinkBinDir   = mempty,
826
    installOneShot         = Flag False,
827
    installNumJobs         = mempty
828
  }
829
830
  where
    docIndexFile = toPathTemplate ("$datadir" </> "doc" </> "index.html")
831

832
833
834
defaultMaxBackjumps :: Int
defaultMaxBackjumps = 200

835
836
defaultSolver :: PreSolver
defaultSolver = Choose
837
838

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

841
installCommand :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
842
installCommand = CommandUI {
843
844
  commandName         = "install",
  commandSynopsis     = "Installs a list of packages.",
refold's avatar
refold committed
845
  commandUsage        = usageFlagsOrPackages "install",
846
847
848
849
850
  commandDescription  = Just $ \pname ->
    let original = case commandDescription configureCommand of
          Just desc -> desc pname ++ "\n"
          Nothing   -> ""
     in original
851
     ++ "Examples:\n"
852
853
854
855
856
857
858
859
     ++ "  " ++ 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"
     ++ "  " ++ pname ++ " install 'foo < 2'       "
     ++ "    Constrained package version\n",
860
  commandDefaultFlags = (mempty, mempty, mempty, mempty),
861
  commandOptions      = \showOrParseArgs ->
862
863
       liftOptions get1 set1 (filter ((/="constraint") . optionName) $
                              configureOptions   showOrParseArgs)
864
865
    ++ liftOptions get2 set2 (configureExOptions showOrParseArgs)
    ++ liftOptions get3 set3 (installOptions     showOrParseArgs)
866
    ++ liftOptions get4 set4 (haddockOptions     showOrParseArgs)
867
  }
868
  where
869
870
871
872
873
    get1 (a,_,_,_) = a; set1 a (_,b,c,d) = (a,b,c,d)
    get2 (_,b,_,_) = b; set2 b (a,_,c,d) = (a,b,c,d)
    get3 (_,_,c,_) = c; set3 c (a,b,_,d) = (a,b,c,d)
    get4 (_,_,_,d) = d; set4 d (a,b,c,_) = (a,b,c,d)

874
875
876
877
878
879
880
881
882
883
884
885
886
haddockOptions :: ShowOrParseArgs -> [OptionField HaddockFlags]
haddockOptions showOrParseArgs
  = [ opt { optionName = "haddock-" ++ name,
            optionDescr = [ fmapOptFlags (\(_, lflags) -> ([], map ("haddock-" ++) lflags)) descr
                          | descr <- optionDescr opt] }
    | opt <- commandOptions Cabal.haddockCommand showOrParseArgs
    , let name = optionName opt
    , name `elem` ["hoogle", "html", "html-location",
                   "executables", "internal", "css",
                   "hyperlink-source", "hscolour-css",
                   "contents-location"]
    ]
  where
887
888
889
890
891
    fmapOptFlags :: (OptFlags -> OptFlags) -> OptDescr a -> OptDescr a
    fmapOptFlags modify (ReqArg d f p r w)    = ReqArg d (modify f) p r w
    fmapOptFlags modify (OptArg d f p r i w)  = OptArg d (modify f) p r i w
    fmapOptFlags modify (ChoiceOpt xs)        = ChoiceOpt [(d, modify f, i, w) | (d, f, i, w) <- xs]
    fmapOptFlags modify (BoolOpt d f1 f2 r w) = BoolOpt d (modify f1) (modify f2) r w
892
893
894
895

installOptions ::  ShowOrParseArgs -> [OptionField InstallFlags]
installOptions showOrParseArgs =
      [ option "" ["documentation"]
896
897
898
899
          "building of documentation"
          installDocumentation (\v flags -> flags { installDocumentation = v })
          (boolOpt [] [])

900
901
      , option [] ["doc-index-file"]
          "A central index of haddock API documentation (template cannot use $pkgid)"
902
903
904
          installHaddockIndex (\v flags -> flags { installHaddockIndex = v })
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
905

906
      , option [] ["dry-run"]
907
908
909
          "Do not install anything, only print what would be installed."
          installDryRun (\v flags -> flags { installDryRun = v })
          trueArg
910
      ] ++
911

912
913
      optionSolverFlags showOrParseArgs
                        installMaxBackjumps     (\v flags -> flags { installMaxBackjumps     = v })
914
                        installReorderGoals     (\v flags -> flags { installReorderGoals     = v })
915
916
                        installIndependentGoals (\v flags -> flags { installIndependentGoals = v })
                        installShadowPkgs       (\v flags -> flags { installShadowPkgs       = v }) ++
917

918
      [ option [] ["reinstall"]
919
920
          "Install even if it means installing the same version again."
          installReinstall (\v flags -> flags { installReinstall = v })
921
          (yesNoOpt showOrParseArgs)
922

923
924
925
      , option [] ["avoid-reinstalls"]
          "Do not select versions that would destructively overwrite installed packages."
          installAvoidReinstalls (\v flags -> flags { installAvoidReinstalls = v })
926
          (yesNoOpt showOrParseArgs)
927

928
      , option [] ["force-reinstalls"]
929
          "Reinstall packages even if they will most likely break other installed packages."
930
          installOverrideReinstall (\v flags -> flags { installOverrideReinstall = v })
931
          (yesNoOpt showOrParseArgs)
932

933
934
935
      , option [] ["upgrade-dependencies"]
          "Pick the latest version for all dependencies, rather than trying to pick an installed version."
          installUpgradeDeps (\v flags -> flags { installUpgradeDeps = v })
936
          (yesNoOpt showOrParseArgs)
937

938
939
940
      , option [] ["only-dependencies"]
          "Install only the dependencies necessary to build the given packages"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
941
          (yesNoOpt showOrParseArgs)
942

943
944
945
946
947
      , option [] ["dependencies-only"]
          "A synonym for --only-dependencies"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
          (yesNoOpt showOrParseArgs)

948
949
950
951
952
      , option [] ["root-cmd"]
          "Command used to gain root privileges, when installing with --global."
          installRootCmd (\v flags -> flags { installRootCmd = v })
          (reqArg' "COMMAND" toFlag flagToList)

953
954
955
956
957
      , option [] ["symlink-bindir"]
          "Add symlinks to installed executables into this directory."
           installSymlinkBinDir (\v flags -> flags { installSymlinkBinDir = v })
           (reqArgFlag "DIR")

958
959
960
961
962
963
      , option [] ["build-summary"]
          "Save build summaries to file (name template can use $pkgid, $compiler, $os, $arch)"
          installSummaryFile (\v flags -> flags { installSummaryFile = v })
          (reqArg' "TEMPLATE" (\x -> [toPathTemplate x]) (map fromPathTemplate))

      , option [] ["build-log"]
Duncan Coutts's avatar
Duncan Coutts committed
964
965
          "Log all builds to file (name template can use $pkgid, $compiler, $os, $arch)"
          installLogFile (\v flags -> flags { installLogFile = v })
966
967
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
Duncan Coutts's avatar
Duncan Coutts committed
968

969
970
      , option [] ["remote-build-reporting"]
          "Generate build reports to send to a remote server (none, anonymous or detailed)."
971
          installBuildReports (\v flags -> flags { installBuildReports = v })
972
973
974
975
          (reqArg "LEVEL" (readP_to_E (const $ "report level must be 'none', "
                                            ++ "'anonymous' or 'detailed'")
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))
976

977
978
979
      , option [] ["one-shot"]
          "Do not record the packages in the world file."
          installOneShot (\v flags -> flags { installOneShot = v })
980
          (yesNoOpt showOrParseArgs)
981
982

      , option "j" ["jobs"]
983
        "Run NUM jobs simultaneously (or '$ncpus' if no NUM is given)."
984
        installNumJobs (\v flags -> flags { installNumJobs = v })
985
        (optArg "NUM" (fmap Flag numJobsParser)
986
                      (Flag Nothing)
987
                      (map (Just . maybe "$ncpus" show) . flagToList))
988
989
      ] ++ case showOrParseArgs of      -- TODO: remove when "cabal install"
                                        -- avoids
990
          ParseArgs ->
EyalLotem's avatar
EyalLotem committed
991
            [ option [] ["only"]
992
993
              "Only installs the package in the current directory."
              installOnly (\v flags -> flags { installOnly = v })
EyalLotem's avatar
EyalLotem committed
994
              trueArg ]
995
          _ -> []
996

997
998

instance Monoid InstallFlags where
999
  mempty = InstallFlags {
1000
    installDocumentation   = mempty,