Setup.hs 42.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(..), globalRepos
15
    , configureCommand, ConfigFlags(..), filterConfigureFlags
16
17
    , configureExCommand, ConfigExFlags(..), defaultConfigExFlags
                        , configureExOptions
18
    , installCommand, InstallFlags(..), installOptions, defaultInstallFlags
19
    , listCommand, ListFlags(..)
Duncan Coutts's avatar
Duncan Coutts committed
20
    , updateCommand
ijones's avatar
ijones committed
21
    , upgradeCommand
22
    , infoCommand, InfoFlags(..)
23
    , fetchCommand, FetchFlags(..)
24
    , checkCommand
25
    , uploadCommand, UploadFlags(..)
26
    , reportCommand, ReportFlags(..)
27
    , unpackCommand, UnpackFlags(..)
28
    , initCommand, IT.InitFlags(..)
29
    , sdistCommand, SDistFlags(..), SDistExFlags(..), ArchiveFormat(..)
Duncan Coutts's avatar
Duncan Coutts committed
30
31

    , parsePackageArgs
32
33
34
    --TODO: stop exporting these:
    , showRepo
    , parseRepo
35
36
    ) where

37
import Distribution.Client.Types
38
         ( Username(..), Password(..), Repo(..), RemoteRepo(..), LocalRepo(..) )
39
40
import Distribution.Client.BuildReports.Types
         ( ReportLevel(..) )
41
42
import Distribution.Client.Dependency.Types
         ( Solver(..) )
43
44
import qualified Distribution.Client.Init.Types as IT
         ( InitFlags(..), PackageType(..) )
45
46
import Distribution.Client.Targets
         ( UserConstraint, readUserConstraint )
47
48
49

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

76
77
import Data.Char
         ( isSpace, isAlphaNum )
78
79
import Data.List
         ( intercalate )
80
import Data.Maybe
81
         ( listToMaybe, maybeToList, fromMaybe )
82
83
84
85
86
87
88
89
import Data.Monoid
         ( Monoid(..) )
import Control.Monad
         ( liftM )
import System.FilePath
         ( (</>) )
import Network.URI
         ( parseAbsoluteURI, uriToString )
90

91
92
93
94
95
96
97
98
99
-- ------------------------------------------------------------
-- * Global flags
-- ------------------------------------------------------------

-- | Flags that apply at the top level, not to any sub-command.
data GlobalFlags = GlobalFlags {
    globalVersion        :: Flag Bool,
    globalNumericVersion :: Flag Bool,
    globalConfigFile     :: Flag FilePath,
100
    globalRemoteRepos    :: [RemoteRepo],     -- ^ Available Hackage servers.
101
    globalCacheDir       :: Flag FilePath,
102
    globalLocalRepos     :: [FilePath],
103
    globalLogsDir        :: Flag FilePath,
104
    globalWorldFile      :: Flag FilePath
105
  }
Duncan Coutts's avatar
Duncan Coutts committed
106

107
108
109
110
111
112
113
defaultGlobalFlags :: GlobalFlags
defaultGlobalFlags  = GlobalFlags {
    globalVersion        = Flag False,
    globalNumericVersion = Flag False,
    globalConfigFile     = mempty,
    globalRemoteRepos    = [],
    globalCacheDir       = mempty,
114
    globalLocalRepos     = mempty,
115
    globalLogsDir        = mempty,
116
    globalWorldFile      = mempty
117
118
119
120
121
122
  }

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

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

167
168
169
170
171
      ,option [] ["logs-dir"]
         "The location to put log files"
         globalLogsDir (\v flags -> flags { globalLogsDir = v })
         (reqArgFlag "DIR")

172
173
174
175
      ,option [] ["world-file"]
         "The location of the world file"
         globalWorldFile (\v flags -> flags { globalWorldFile = v })
         (reqArgFlag "FILE")
176
177
178
179
180
181
182
183
184
185
      ]
  }

instance Monoid GlobalFlags where
  mempty = GlobalFlags {
    globalVersion        = mempty,
    globalNumericVersion = mempty,
    globalConfigFile     = mempty,
    globalRemoteRepos    = mempty,
    globalCacheDir       = mempty,
186
    globalLocalRepos     = mempty,
187
    globalLogsDir        = mempty,
188
    globalWorldFile      = mempty
189
190
191
192
193
194
195
  }
  mappend a b = GlobalFlags {
    globalVersion        = combine globalVersion,
    globalNumericVersion = combine globalNumericVersion,
    globalConfigFile     = combine globalConfigFile,
    globalRemoteRepos    = combine globalRemoteRepos,
    globalCacheDir       = combine globalCacheDir,
196
    globalLocalRepos     = combine globalLocalRepos,
197
    globalLogsDir        = combine globalLogsDir,
198
    globalWorldFile      = combine globalWorldFile
Duncan Coutts's avatar
Duncan Coutts committed
199
  }
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
    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
217

218
configureCommand :: CommandUI ConfigFlags
219
configureCommand = (Cabal.configureCommand defaultProgramConfiguration) {
220
    commandDefaultFlags = mempty
Duncan Coutts's avatar
Duncan Coutts committed
221
222
  }

223
224
225
configureOptions ::  ShowOrParseArgs -> [OptionField ConfigFlags]
configureOptions = commandOptions configureCommand

226
filterConfigureFlags :: ConfigFlags -> Version -> ConfigFlags
227
228
229
filterConfigureFlags flags cabalLibVersion
  | cabalLibVersion >= Version [1,3,10] [] = flags
    -- older Cabal does not grok the constraints flag:
230
  | otherwise = flags { configConstraints = [] }
231

232
233
234
235
236
237
238
239
-- ------------------------------------------------------------
-- * Config extra flags
-- ------------------------------------------------------------

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
240
    configExConstraints:: [UserConstraint],
241
242
243
244
245
246
247
248
249
250
    configPreferences  :: [Dependency]
  }

defaultConfigExFlags :: ConfigExFlags
defaultConfigExFlags = mempty

configureExCommand :: CommandUI (ConfigFlags, ConfigExFlags)
configureExCommand = configureCommand {
    commandDefaultFlags = (mempty, defaultConfigExFlags),
    commandOptions      = \showOrParseArgs ->
251
252
         liftOptions fst setFst (filter ((/="constraint") . optionName) $
                                 configureOptions   showOrParseArgs)
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
      ++ 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))
268
269
270
271
272
273
  , 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))
274
275
276
277

  , option [] ["preference"]
      "Specify preferences (soft constraints) on the version of a package"
      configPreferences (\v flags -> flags { configPreferences = v })
278
279
280
281
      (reqArg "CONSTRAINT"
              (readP_to_E (const "dependency expected")
                          (fmap (\x -> [x]) parse))
              (map display))
282
283
284
285
286
  ]

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
287
    configExConstraints= mempty,
288
289
290
291
    configPreferences  = mempty
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
292
    configExConstraints= combine configExConstraints,
293
294
295
296
    configPreferences  = combine configPreferences
  }
    where combine field = field a `mappend` field b

297
-- ------------------------------------------------------------
298
-- * Fetch command
299
-- ------------------------------------------------------------
300

301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
317
318
fetchCommand = CommandUI {
    commandName         = "fetch",
319
    commandSynopsis     = "Downloads packages for later installation.",
Duncan Coutts's avatar
Duncan Coutts committed
320
321
    commandDescription  = Nothing,
    commandUsage        = usagePackages "fetch",
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
    commandDefaultFlags = defaultFetchFlags,
    commandOptions      = \_ -> [
         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
       ]
Duncan Coutts's avatar
Duncan Coutts committed
346
347
  }

348
349
350
351
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

352
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
353
354
355
356
357
updateCommand = CommandUI {
    commandName         = "update",
    commandSynopsis     = "Updates list of known packages",
    commandDescription  = Nothing,
    commandUsage        = usagePackages "update",
358
    commandDefaultFlags = toFlag normal,
359
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
360
361
  }

362
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
363
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
364
    commandName         = "upgrade",
365
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
366
    commandDescription  = Nothing,
367
    commandUsage        = usagePackages "upgrade",
368
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
369
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
370
371
  }

Duncan Coutts's avatar
Duncan Coutts committed
372
373
374
375
376
377
378
379
380
381
382
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

383
384
385
386
387
388
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
    commandSynopsis     = "Check the package for common mistakes",
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
389
    commandDefaultFlags = toFlag normal,
390
    commandOptions      = \_ -> []
391
392
  }

393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
-- ------------------------------------------------------------
-- * 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
411
412
413
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
    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))
      ]
434
435
  }

436
437
438
439
440
441
442
443
444
445
446
447
448
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

449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
-- ------------------------------------------------------------
-- * Unpack flags
-- ------------------------------------------------------------

data UnpackFlags = UnpackFlags {
      unpackDestDir :: Flag FilePath,
      unpackVerbosity :: Flag Verbosity
    }

defaultUnpackFlags :: UnpackFlags
defaultUnpackFlags = UnpackFlags {
    unpackDestDir = mempty,
    unpackVerbosity = toFlag normal
   }

unpackCommand :: CommandUI UnpackFlags
unpackCommand = CommandUI {
    commandName         = "unpack",
    commandSynopsis     = "Unpacks packages for user inspection.",
    commandDescription  = Nothing,
    commandUsage        = usagePackages "unpack",
    commandDefaultFlags = mempty,
    commandOptions      = \_ -> [
        optionVerbosity unpackVerbosity (\v flags -> flags { unpackVerbosity = v })

       ,option "d" ["destdir"]
         "where to unpack the packages, defaults to the current directory."
         unpackDestDir (\v flags -> flags { unpackDestDir = v })
         (reqArgFlag "PATH")
       ]
  }

instance Monoid UnpackFlags where
  mempty = defaultUnpackFlags
  mappend a b = UnpackFlags {
     unpackDestDir = combine unpackDestDir
    ,unpackVerbosity = combine unpackVerbosity
  }
    where combine field = field a `mappend` field b

489
490
491
492
493
494
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
    listInstalled :: Flag Bool,
495
    listSimpleOutput :: Flag Bool,
496
497
498
499
500
501
    listVerbosity :: Flag Verbosity
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
    listInstalled = Flag False,
502
    listSimpleOutput = Flag False,
503
504
505
506
507
508
    listVerbosity = toFlag normal
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
509
    commandSynopsis     = "List packages matching a search string.",
510
511
    commandDescription  = Nothing,
    commandUsage        = usagePackages "list",
512
    commandDefaultFlags = defaultListFlags,
513
    commandOptions      = \_ -> [
514
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
515

516
        , option [] ["installed"]
517
518
519
520
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

521
522
523
524
525
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

526
527
528
529
530
531
532
        ]
  }

instance Monoid ListFlags where
  mempty = defaultListFlags
  mappend a b = ListFlags {
    listInstalled = combine listInstalled,
533
    listSimpleOutput = combine listSimpleOutput,
534
535
536
537
    listVerbosity = combine listVerbosity
  }
    where combine field = field a `mappend` field b

538
539
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
-- ------------------------------------------------------------
-- * 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,
    commandUsage        = usagePackages "info",
    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

570
571
572
573
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

574
575
-- | Install takes the same flags as configure along with a few extras.
--
576
data InstallFlags = InstallFlags {
577
578
579
    installDocumentation    :: Flag Bool,
    installHaddockIndex     :: Flag PathTemplate,
    installDryRun           :: Flag Bool,
580
    installSolver           :: Flag Solver,
581
582
    installReinstall        :: Flag Bool,
    installAvoidReinstalls  :: Flag Bool,
583
    installOverrideReinstall :: Flag Bool,
584
585
586
587
588
589
590
591
592
593
594
595
    installMaxBackjumps     :: Flag Int,
    installUpgradeDeps      :: Flag Bool,
    installReorderGoals     :: Flag Bool,
    installIndependentGoals :: Flag Bool,
    installOnly             :: Flag Bool,
    installOnlyDeps         :: Flag Bool,
    installRootCmd          :: Flag String,
    installSummaryFile      :: [PathTemplate],
    installLogFile          :: Flag PathTemplate,
    installBuildReports     :: Flag ReportLevel,
    installSymlinkBinDir    :: Flag FilePath,
    installOneShot          :: Flag Bool
596
597
598
599
  }

defaultInstallFlags :: InstallFlags
defaultInstallFlags = InstallFlags {
600
601
602
    installDocumentation   = Flag False,
    installHaddockIndex    = Flag docIndexFile,
    installDryRun          = Flag False,
603
    installSolver          = Flag defaultSolver,
604
605
    installReinstall       = Flag False,
    installAvoidReinstalls = Flag False,
606
    installOverrideReinstall = Flag False,
Andres Löh's avatar
Andres Löh committed
607
    installMaxBackjumps    = Flag defaultMaxBackjumps,
608
    installUpgradeDeps     = Flag False,
Andres Löh's avatar
Andres Löh committed
609
    installReorderGoals    = Flag False,
610
    installIndependentGoals= Flag False,
611
612
613
614
615
616
617
618
    installOnly            = Flag False,
    installOnlyDeps        = Flag False,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = Flag NoReports,
    installSymlinkBinDir   = mempty,
    installOneShot         = Flag False
619
  }
620
621
  where
    docIndexFile = toPathTemplate ("$datadir" </> "doc" </> "index.html")
622

623
624
625
defaultMaxBackjumps :: Int
defaultMaxBackjumps = 200

626
627
628
629
630
631
defaultSolver :: Solver
defaultSolver = TopDown

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

632
installCommand :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
633
installCommand = CommandUI {
634
635
636
  commandName         = "install",
  commandSynopsis     = "Installs a list of packages.",
  commandUsage        = usagePackages "install",
637
638
639
640
641
  commandDescription  = Just $ \pname ->
    let original = case commandDescription configureCommand of
          Just desc -> desc pname ++ "\n"
          Nothing   -> ""
     in original
642
     ++ "Examples:\n"
643
644
645
646
647
648
649
650
     ++ "  " ++ 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",
651
  commandDefaultFlags = (mempty, mempty, mempty, mempty),
652
  commandOptions      = \showOrParseArgs ->
653
654
       liftOptions get1 set1 (filter ((/="constraint") . optionName) $
                              configureOptions   showOrParseArgs)
655
656
    ++ liftOptions get2 set2 (configureExOptions showOrParseArgs)
    ++ liftOptions get3 set3 (installOptions     showOrParseArgs)
657
    ++ liftOptions get4 set4 (haddockOptions     showOrParseArgs)
658
  }
659
  where
660
661
662
663
664
665
666
667
668
669
670
671
672
    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)

    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",
673
674
                       "hyperlink-source", "hscolour-css",
                       "contents-location"]
675
676
677
678
679
680
681
        ]

    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
682
683
684
685

installOptions ::  ShowOrParseArgs -> [OptionField InstallFlags]
installOptions showOrParseArgs =
      [ option "" ["documentation"]
686
687
688
689
          "building of documentation"
          installDocumentation (\v flags -> flags { installDocumentation = v })
          (boolOpt [] [])

690
691
      , option [] ["doc-index-file"]
          "A central index of haddock API documentation (template cannot use $pkgid)"
692
693
694
          installHaddockIndex (\v flags -> flags { installHaddockIndex = v })
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
695

696
      , option [] ["dry-run"]
697
698
699
          "Do not install anything, only print what would be installed."
          installDryRun (\v flags -> flags { installDryRun = v })
          trueArg
700

701
702
703
704
705
706
707
      , option [] ["solver"]
          ("Select dependency solver to use (default: " ++ display defaultSolver ++ "). Choices: " ++ allSolvers ++ ".")
          installSolver (\v flags -> flags { installSolver = v })
          (reqArg "SOLVER" (readP_to_E (const $ "solver must be one of: " ++ allSolvers)
                                       (toFlag `fmap` parse))
                           (flagToList . fmap display))

708
709
710
711
712
      , option [] ["reinstall"]
          "Install even if it means installing the same version again."
          installReinstall (\v flags -> flags { installReinstall = v })
          trueArg

713
714
715
716
717
      , option [] ["avoid-reinstalls"]
          "Do not select versions that would destructively overwrite installed packages."
          installAvoidReinstalls (\v flags -> flags { installAvoidReinstalls = v })
          trueArg

718
719
720
721
722
      , option [] ["override-reinstall-check"]
          "Use to override the check that prevents reinstalling already installed versions of package dependencies."
          installOverrideReinstall (\v flags -> flags { installOverrideReinstall = v })
          trueArg

Andres Löh's avatar
Andres Löh committed
723
724
725
726
727
728
729
      , option [] ["max-backjumps"]
          ("Maximum number of backjumps allowed while solving (default: " ++ show defaultMaxBackjumps ++ "). Use a negative number to enable unlimited backtracking. Use 0 to disable backtracking completely.")
          installMaxBackjumps (\v flags -> flags { installMaxBackjumps = v })
          (reqArg "NUM" (readP_to_E ("Cannot parse number: "++)
                                    (fmap toFlag (Parse.readS_to_P reads)))
                        (map show . flagToList))

730
731
732
733
734
      , option [] ["upgrade-dependencies"]
          "Pick the latest version for all dependencies, rather than trying to pick an installed version."
          installUpgradeDeps (\v flags -> flags { installUpgradeDeps = v })
          trueArg

Andres Löh's avatar
Andres Löh committed
735
      , option [] ["reorder-goals"]
736
          "Try to reorder goals according to certain heuristics. Slows things down on average, but may make backtracking faster for some packages."
Andres Löh's avatar
Andres Löh committed
737
738
          installReorderGoals (\v flags -> flags { installReorderGoals = v })
          trueArg
739

740
741
742
743
744
      , option [] ["independent-goals"]
          "Treat several goals on the command line as independent. If several goals depend on the same package, different versions can be chosen."
          installIndependentGoals (\v flags -> flags { installIndependentGoals = v })
          trueArg

745
746
747
748
749
750
      , option [] ["only-dependencies"]
          "Install only the dependencies necessary to build the given packages"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
          trueArg


751
752
753
754
755
      , option [] ["root-cmd"]
          "Command used to gain root privileges, when installing with --global."
          installRootCmd (\v flags -> flags { installRootCmd = v })
          (reqArg' "COMMAND" toFlag flagToList)

756
757
758
759
760
      , option [] ["symlink-bindir"]
          "Add symlinks to installed executables into this directory."
           installSymlinkBinDir (\v flags -> flags { installSymlinkBinDir = v })
           (reqArgFlag "DIR")

761
762
763
764
765
766
      , 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
767
768
          "Log all builds to file (name template can use $pkgid, $compiler, $os, $arch)"
          installLogFile (\v flags -> flags { installLogFile = v })
769
770
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
Duncan Coutts's avatar
Duncan Coutts committed
771

772
773
      , option [] ["remote-build-reporting"]
          "Generate build reports to send to a remote server (none, anonymous or detailed)."
774
          installBuildReports (\v flags -> flags { installBuildReports = v })
775
776
777
778
          (reqArg "LEVEL" (readP_to_E (const $ "report level must be 'none', "
                                            ++ "'anonymous' or 'detailed'")
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))
779

780
781
782
783
      , option [] ["one-shot"]
          "Do not record the packages in the world file."
          installOneShot (\v flags -> flags { installOneShot = v })
          trueArg
784
785
786
787
788
789
790
      ] ++ case showOrParseArgs of      -- TODO: remove when "cabal install" avoids
          ParseArgs ->
            option [] ["only"]
              "Only installs the package in the current directory."
              installOnly (\v flags -> flags { installOnly = v })
              trueArg
             : []
791
          _ -> []
792
793

instance Monoid InstallFlags where
794
  mempty = InstallFlags {
795
796
797
    installDocumentation   = mempty,
    installHaddockIndex    = mempty,
    installDryRun          = mempty,
798
    installSolver          = mempty,
799
800
    installReinstall       = mempty,
    installAvoidReinstalls = mempty,
801
    installOverrideReinstall = mempty,
Andres Löh's avatar
Andres Löh committed
802
    installMaxBackjumps    = mempty,
803
    installUpgradeDeps     = mempty,
Andres Löh's avatar
Andres Löh committed
804
    installReorderGoals    = mempty,
805
    installIndependentGoals= mempty,
806
807
808
809
810
811
812
813
    installOnly            = mempty,
    installOnlyDeps        = mempty,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = mempty,
    installSymlinkBinDir   = mempty,
    installOneShot         = mempty
814
  }
815
  mappend a b = InstallFlags {
816
817
818
    installDocumentation   = combine installDocumentation,
    installHaddockIndex    = combine installHaddockIndex,
    installDryRun          = combine installDryRun,
819
    installSolver          = combine installSolver,
820
821
    installReinstall       = combine installReinstall,
    installAvoidReinstalls = combine installAvoidReinstalls,
822
    installOverrideReinstall = combine installOverrideReinstall,
Andres Löh's avatar
Andres Löh committed
823
    installMaxBackjumps    = combine installMaxBackjumps,
824
    installUpgradeDeps     = combine installUpgradeDeps,
Andres Löh's avatar
Andres Löh committed
825
    installReorderGoals    = combine installReorderGoals,
826
    installIndependentGoals= combine installIndependentGoals,
827
828
829
830
831
832
833
834
    installOnly            = combine installOnly,
    installOnlyDeps        = combine installOnlyDeps,
    installRootCmd         = combine installRootCmd,
    installSummaryFile     = combine installSummaryFile,
    installLogFile         = combine installLogFile,
    installBuildReports    = combine installBuildReports,
    installSymlinkBinDir   = combine installSymlinkBinDir,
    installOneShot         = combine installOneShot
835
836
837
  }
    where combine field = field a `mappend` field b

838
839
840
841
842
843
844
845
846
-- ------------------------------------------------------------
-- * Upload flags
-- ------------------------------------------------------------

data UploadFlags = UploadFlags {
    uploadCheck     :: Flag Bool,
    uploadUsername  :: Flag Username,
    uploadPassword  :: Flag Password,
    uploadVerbosity :: Flag Verbosity
847
  }
848
849
850
851
852
853
854
855
856
857
858
859
860
861

defaultUploadFlags :: UploadFlags
defaultUploadFlags = UploadFlags {
    uploadCheck     = toFlag False,
    uploadUsername  = mempty,
    uploadPassword  = mempty,
    uploadVerbosity = toFlag normal
  }

uploadCommand :: CommandUI UploadFlags
uploadCommand = CommandUI {
    commandName         = "upload",
    commandSynopsis     = "Uploads source packages to Hackage",
    commandDescription  = Just $ \_ ->
862
         "You can store your Hackage login in the ~/.cabal/config file\n",
863
864
865
866
867
    commandUsage        = \pname ->
         "Usage: " ++ pname ++ " upload [FLAGS] [TARFILES]\n\n"
      ++ "Flags for upload:",
    commandDefaultFlags = defaultUploadFlags,
    commandOptions      = \_ ->
868
      [optionVerbosity uploadVerbosity (\v flags -> flags { uploadVerbosity = v })
869
870
871
872

      ,option ['c'] ["check"]
         "Do not upload, just do QA checks."
        uploadCheck (\v flags -> flags { uploadCheck = v })
873
        trueArg
874
875
876
877

      ,option ['u'] ["username"]
        "Hackage username."
        uploadUsername (\v flags -> flags { uploadUsername = v })
878
879
        (reqArg' "USERNAME" (toFlag . Username)
                            (flagToList . fmap unUsername))
880
881
882
883

      ,option ['p'] ["password"]
        "Hackage password."
        uploadPassword (\v flags -> flags { uploadPassword = v })
884
885
        (reqArg' "PASSWORD" (toFlag . Password)
                            (flagToList . fmap unPassword))
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
      ]
  }

instance Monoid UploadFlags where
  mempty = UploadFlags {
    uploadCheck     = mempty,
    uploadUsername  = mempty,
    uploadPassword  = mempty,
    uploadVerbosity = mempty
  }
  mappend a b = UploadFlags {
    uploadCheck     = combine uploadCheck,
    uploadUsername  = combine uploadUsername,
    uploadPassword  = combine uploadPassword,
    uploadVerbosity = combine uploadVerbosity
  }
    where combine field = field a `mappend` field b

904
905
906
907
908
909
910
911
912
913
914
915
916
917
-- ------------------------------------------------------------
-- * Init flags
-- ------------------------------------------------------------

emptyInitFlags :: IT.InitFlags
emptyInitFlags  = mempty

defaultInitFlags :: IT.InitFlags
defaultInitFlags  = emptyInitFlags

initCommand :: CommandUI IT.InitFlags
initCommand = CommandUI {
    commandName = "init",
    commandSynopsis = "Interactively create a .cabal file.",
918
919
920
921
922
923
924
925
926
927
928
929
    commandDescription = Just $ \_ -> wrapText $
         "Cabalise a project by creating a .cabal, Setup.hs, and "
      ++ "optionally a LICENSE file.\n\n"
      ++ "Calling init with no arguments (recommended) uses an "
      ++ "interactive mode, which will try to guess as much as "
      ++ "possible and prompt you for the rest.  Command-line "
      ++ "arguments are provided for scripting purposes. "
      ++ "If you don't want interactive mode, be sure to pass "
      ++ "the -n flag.\n",
    commandUsage = \pname ->
         "Usage: " ++ pname ++ " init [FLAGS]\n\n"
      ++ "Flags for init:",
930
931
    commandDefaultFlags = defaultInitFlags,
    commandOptions = \_ ->
932
      [ option ['n'] ["non-interactive"]
933
934
935
936
937
938
939
940
941
        "Non-interactive mode."
        IT.nonInteractive (\v flags -> flags { IT.nonInteractive = v })
        trueArg

      , option ['q'] ["quiet"]
        "Do not generate log messages to stdout."
        IT.quiet (\v flags -> flags { IT.quiet = v })
        trueArg

942
      , option [] ["no-comments"]
943
944
945
946
947
        "Do not generate explanatory comments in the .cabal file."
        IT.noComments (\v flags -> flags { IT.noComments = v })
        trueArg

      , option ['m'] ["minimal"]
948
        "Generate a minimal .cabal file, that is, do not include extra empty fields.  Also implies --no-comments."
949
950
951
        IT.minimal (\v flags -> flags { IT.minimal = v })
        trueArg

952
      , option [] ["package-dir"]
953
954
955
956
        "Root directory of the package (default = current directory)."
        IT.packageDir (\v flags -> flags { IT.packageDir = v })
        (reqArgFlag "DIRECTORY")

957
      , option ['p'] ["package-name"]
958
959
960
961
962
963
964
965
966
967
968
        "Name of the Cabal package to create."
        IT.packageName (\v flags -> flags { IT.packageName = v })
        (reqArgFlag "PACKAGE")

      , option [] ["version"]
        "Initial version of the package."
        IT.version (\v flags -> flags { IT.version = v })
        (reqArg "VERSION" (readP_to_E ("Cannot parse package version: "++)
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))

969
      , option [] ["cabal-version"]
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
        "Required version of the Cabal library."
        IT.cabalVersion (\v flags -> flags { IT.cabalVersion = v })
        (reqArg "VERSION_RANGE" (readP_to_E ("Cannot parse Cabal version range: "++)
                                            (toFlag `fmap` parse))
                                (flagToList . fmap display))

      , option ['l'] ["license"]
        "Project license."
        IT.license (\v flags -> flags { IT.license = v })
        (reqArg "LICENSE" (readP_to_E ("Cannot parse license: "++)
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))

      , option ['a'] ["author"]
        "Name of the project's author."
        IT.author (\v flags -> flags { IT.author = v })
        (reqArgFlag "NAME")

      , option ['e'] ["email"]
        "Email address of the maintainer."
        IT.email (\v flags -> flags { IT.email = v })
        (reqArgFlag "EMAIL")

      , option ['u'] ["homepage"]
        "Project homepage and/or repository."
        IT.homepage (\v flags -> flags { IT.homepage = v })
        (reqArgFlag "URL")

      , option ['s'] ["synopsis"]
        "Short project synopsis."
        IT.synopsis (\v flags -> flags { IT.synopsis = v })