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

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

90
91
92
93
94
95
96
97
98
-- ------------------------------------------------------------
-- * 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,
99
    globalRemoteRepos    :: [RemoteRepo],     -- ^ Available Hackage servers.
100
    globalCacheDir       :: Flag FilePath,
101
    globalLocalRepos     :: [FilePath],
102
    globalLogsDir        :: Flag FilePath,
103
    globalWorldFile      :: Flag FilePath
104
  }
Duncan Coutts's avatar
Duncan Coutts committed
105

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

globalCommand :: CommandUI GlobalFlags
globalCommand = CommandUI {
    commandName         = "",
    commandSynopsis     = "",
122
123
124
125
    commandUsage        = \_ ->
         "This program is the command line interface "
           ++ "to the Haskell Cabal infrastructure.\n"
      ++ "See http://www.haskell.org/cabal/ for more information.\n",
126
    commandDescription  = Just $ \pname ->
127
128
129
130
131
132
         "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",
133
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
    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)
165

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

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

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

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

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

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

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

-- | cabal configure takes some extra flags beyond runghc Setup configure
--
data ConfigExFlags = ConfigExFlags {
    configCabalVersion :: Flag Version,
239
    configExConstraints:: [UserConstraint],
240
    configPreferences  :: [Dependency],
241
    configSolver       :: Flag PreSolver
242
243
244
  }

defaultConfigExFlags :: ConfigExFlags
245
defaultConfigExFlags = mempty { configSolver = Flag defaultSolver }
246
247
248
249
250

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

  , optionSolver configSolver (\v flags -> flags { configSolver = v })
284
285
286
287
288
  ]

instance Monoid ConfigExFlags where
  mempty = ConfigExFlags {
    configCabalVersion = mempty,
289
    configExConstraints= mempty,
290
291
    configPreferences  = mempty,
    configSolver       = mempty
292
293
294
  }
  mappend a b = ConfigExFlags {
    configCabalVersion = combine configCabalVersion,
295
    configExConstraints= combine configExConstraints,
296
297
    configPreferences  = combine configPreferences,
    configSolver       = combine configSolver
298
299
300
  }
    where combine field = field a `mappend` field b

301
-- ------------------------------------------------------------
302
-- * Fetch command
303
-- ------------------------------------------------------------
304

305
306
307
308
data FetchFlags = FetchFlags {
--    fetchOutput    :: Flag FilePath,
      fetchDeps      :: Flag Bool,
      fetchDryRun    :: Flag Bool,
309
      fetchSolver           :: Flag PreSolver,
310
311
312
      fetchMaxBackjumps     :: Flag Int,
      fetchReorderGoals     :: Flag Bool,
      fetchIndependentGoals :: Flag Bool,
313
      fetchShadowPkgs       :: Flag Bool,
314
315
316
317
318
319
320
321
      fetchVerbosity :: Flag Verbosity
    }

defaultFetchFlags :: FetchFlags
defaultFetchFlags = FetchFlags {
--  fetchOutput    = mempty,
    fetchDeps      = toFlag True,
    fetchDryRun    = toFlag False,
322
323
324
325
    fetchSolver           = Flag defaultSolver,
    fetchMaxBackjumps     = Flag defaultMaxBackjumps,
    fetchReorderGoals     = Flag False,
    fetchIndependentGoals = Flag False,
326
    fetchShadowPkgs       = Flag False,
327
328
329
330
    fetchVerbosity = toFlag normal
   }

fetchCommand :: CommandUI FetchFlags
Duncan Coutts's avatar
Duncan Coutts committed
331
332
fetchCommand = CommandUI {
    commandName         = "fetch",
333
    commandSynopsis     = "Downloads packages for later installation.",
Duncan Coutts's avatar
Duncan Coutts committed
334
335
    commandDescription  = Nothing,
    commandUsage        = usagePackages "fetch",
336
    commandDefaultFlags = defaultFetchFlags,
337
    commandOptions      = \ showOrParseArgs -> [
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
         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
359
360
361
362

       ] ++

       optionSolver      fetchSolver           (\v flags -> flags { fetchSolver           = v }) :
363
364
       optionSolverFlags showOrParseArgs
                         fetchMaxBackjumps     (\v flags -> flags { fetchMaxBackjumps     = v })
365
366
                         fetchReorderGoals     (\v flags -> flags { fetchReorderGoals     = v })
                         fetchIndependentGoals (\v flags -> flags { fetchIndependentGoals = v })
367
                         fetchShadowPkgs       (\v flags -> flags { fetchShadowPkgs       = v })
368

Duncan Coutts's avatar
Duncan Coutts committed
369
370
  }

371
372
373
374
-- ------------------------------------------------------------
-- * Other commands
-- ------------------------------------------------------------

375
updateCommand  :: CommandUI (Flag Verbosity)
Duncan Coutts's avatar
Duncan Coutts committed
376
377
378
379
380
updateCommand = CommandUI {
    commandName         = "update",
    commandSynopsis     = "Updates list of known packages",
    commandDescription  = Nothing,
    commandUsage        = usagePackages "update",
381
    commandDefaultFlags = toFlag normal,
382
    commandOptions      = \_ -> [optionVerbosity id const]
Duncan Coutts's avatar
Duncan Coutts committed
383
384
  }

385
upgradeCommand  :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
386
upgradeCommand = configureCommand {
ijones's avatar
ijones committed
387
    commandName         = "upgrade",
388
    commandSynopsis     = "(command disabled, use install instead)",
ijones's avatar
ijones committed
389
    commandDescription  = Nothing,
390
    commandUsage        = usagePackages "upgrade",
391
    commandDefaultFlags = (mempty, mempty, mempty, mempty),
392
    commandOptions      = commandOptions installCommand
ijones's avatar
ijones committed
393
394
  }

Duncan Coutts's avatar
Duncan Coutts committed
395
396
397
398
399
400
401
402
403
404
405
{-
cleanCommand  :: CommandUI ()
cleanCommand = makeCommand name shortDesc longDesc emptyFlags options
  where
    name       = "clean"
    shortDesc  = "Removes downloaded files"
    longDesc   = Nothing
    emptyFlags = ()
    options _  = []
-}

406
407
408
409
410
411
checkCommand  :: CommandUI (Flag Verbosity)
checkCommand = CommandUI {
    commandName         = "check",
    commandSynopsis     = "Check the package for common mistakes",
    commandDescription  = Nothing,
    commandUsage        = \pname -> "Usage: " ++ pname ++ " check\n",
412
    commandDefaultFlags = toFlag normal,
413
    commandOptions      = \_ -> []
414
415
  }

416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
-- ------------------------------------------------------------
-- * 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
434
435
436
reportCommand = CommandUI {
    commandName         = "report",
    commandSynopsis     = "Upload build reports to a remote server.",
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
    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))
      ]
457
458
  }

459
460
461
462
463
464
465
466
467
468
469
470
471
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

472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
-- ------------------------------------------------------------
-- * 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

512
513
514
515
516
517
-- ------------------------------------------------------------
-- * List flags
-- ------------------------------------------------------------

data ListFlags = ListFlags {
    listInstalled :: Flag Bool,
518
    listSimpleOutput :: Flag Bool,
519
520
521
522
523
524
    listVerbosity :: Flag Verbosity
  }

defaultListFlags :: ListFlags
defaultListFlags = ListFlags {
    listInstalled = Flag False,
525
    listSimpleOutput = Flag False,
526
527
528
529
530
531
    listVerbosity = toFlag normal
  }

listCommand  :: CommandUI ListFlags
listCommand = CommandUI {
    commandName         = "list",
532
    commandSynopsis     = "List packages matching a search string.",
533
534
    commandDescription  = Nothing,
    commandUsage        = usagePackages "list",
535
    commandDefaultFlags = defaultListFlags,
536
    commandOptions      = \_ -> [
537
        optionVerbosity listVerbosity (\v flags -> flags { listVerbosity = v })
538

539
        , option [] ["installed"]
540
541
542
543
            "Only print installed packages"
            listInstalled (\v flags -> flags { listInstalled = v })
            trueArg

544
545
546
547
548
        , option [] ["simple-output"]
            "Print in a easy-to-parse format"
            listSimpleOutput (\v flags -> flags { listSimpleOutput = v })
            trueArg

549
550
551
552
553
554
555
        ]
  }

instance Monoid ListFlags where
  mempty = defaultListFlags
  mappend a b = ListFlags {
    listInstalled = combine listInstalled,
556
    listSimpleOutput = combine listSimpleOutput,
557
558
559
560
    listVerbosity = combine listVerbosity
  }
    where combine field = field a `mappend` field b

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
-- ------------------------------------------------------------
-- * 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

593
594
595
596
-- ------------------------------------------------------------
-- * Install flags
-- ------------------------------------------------------------

597
598
-- | Install takes the same flags as configure along with a few extras.
--
599
data InstallFlags = InstallFlags {
600
601
602
    installDocumentation    :: Flag Bool,
    installHaddockIndex     :: Flag PathTemplate,
    installDryRun           :: Flag Bool,
603
604
605
    installMaxBackjumps     :: Flag Int,
    installReorderGoals     :: Flag Bool,
    installIndependentGoals :: Flag Bool,
606
    installShadowPkgs       :: Flag Bool,
607
608
    installReinstall        :: Flag Bool,
    installAvoidReinstalls  :: Flag Bool,
609
    installOverrideReinstall :: Flag Bool,
610
611
612
613
614
615
616
617
    installUpgradeDeps      :: Flag Bool,
    installOnly             :: Flag Bool,
    installOnlyDeps         :: Flag Bool,
    installRootCmd          :: Flag String,
    installSummaryFile      :: [PathTemplate],
    installLogFile          :: Flag PathTemplate,
    installBuildReports     :: Flag ReportLevel,
    installSymlinkBinDir    :: Flag FilePath,
618
619
    installOneShot          :: Flag Bool,
    installNumJobs          :: Flag Int
620
621
622
623
  }

defaultInstallFlags :: InstallFlags
defaultInstallFlags = InstallFlags {
624
625
626
    installDocumentation   = Flag False,
    installHaddockIndex    = Flag docIndexFile,
    installDryRun          = Flag False,
627
628
629
    installMaxBackjumps    = Flag defaultMaxBackjumps,
    installReorderGoals    = Flag False,
    installIndependentGoals= Flag False,
630
    installShadowPkgs      = Flag False,
631
632
    installReinstall       = Flag False,
    installAvoidReinstalls = Flag False,
633
    installOverrideReinstall = Flag False,
634
635
636
637
638
639
640
641
    installUpgradeDeps     = Flag False,
    installOnly            = Flag False,
    installOnlyDeps        = Flag False,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = Flag NoReports,
    installSymlinkBinDir   = mempty,
642
643
    installOneShot         = Flag False,
    installNumJobs         = Flag 1
644
  }
645
646
  where
    docIndexFile = toPathTemplate ("$datadir" </> "doc" </> "index.html")
647

648
649
650
defaultMaxBackjumps :: Int
defaultMaxBackjumps = 200

651
652
defaultSolver :: PreSolver
defaultSolver = Choose
653
654

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

657
installCommand :: CommandUI (ConfigFlags, ConfigExFlags, InstallFlags, HaddockFlags)
658
installCommand = CommandUI {
659
660
661
  commandName         = "install",
  commandSynopsis     = "Installs a list of packages.",
  commandUsage        = usagePackages "install",
662
663
664
665
666
  commandDescription  = Just $ \pname ->
    let original = case commandDescription configureCommand of
          Just desc -> desc pname ++ "\n"
          Nothing   -> ""
     in original
667
     ++ "Examples:\n"
668
669
670
671
672
673
674
675
     ++ "  " ++ 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",
676
  commandDefaultFlags = (mempty, mempty, mempty, mempty),
677
  commandOptions      = \showOrParseArgs ->
678
679
       liftOptions get1 set1 (filter ((/="constraint") . optionName) $
                              configureOptions   showOrParseArgs)
680
681
    ++ liftOptions get2 set2 (configureExOptions showOrParseArgs)
    ++ liftOptions get3 set3 (installOptions     showOrParseArgs)
682
    ++ liftOptions get4 set4 (haddockOptions     showOrParseArgs)
683
  }
684
  where
685
686
687
688
689
690
691
692
693
694
695
696
697
    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",
698
699
                       "hyperlink-source", "hscolour-css",
                       "contents-location"]
700
701
702
703
704
705
706
        ]

    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
707
708
709
710

installOptions ::  ShowOrParseArgs -> [OptionField InstallFlags]
installOptions showOrParseArgs =
      [ option "" ["documentation"]
711
712
713
714
          "building of documentation"
          installDocumentation (\v flags -> flags { installDocumentation = v })
          (boolOpt [] [])

715
716
      , option [] ["doc-index-file"]
          "A central index of haddock API documentation (template cannot use $pkgid)"
717
718
719
          installHaddockIndex (\v flags -> flags { installHaddockIndex = v })
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
720

721
      , option [] ["dry-run"]
722
723
724
          "Do not install anything, only print what would be installed."
          installDryRun (\v flags -> flags { installDryRun = v })
          trueArg
725
      ] ++
726

727
728
      optionSolverFlags showOrParseArgs
                        installMaxBackjumps     (\v flags -> flags { installMaxBackjumps     = v })
729
                        installReorderGoals     (\v flags -> flags { installReorderGoals     = v })
730
731
                        installIndependentGoals (\v flags -> flags { installIndependentGoals = v })
                        installShadowPkgs       (\v flags -> flags { installShadowPkgs       = v }) ++
732

733
      [ option [] ["reinstall"]
734
735
          "Install even if it means installing the same version again."
          installReinstall (\v flags -> flags { installReinstall = v })
736
          (yesNoOpt showOrParseArgs)
737

738
739
740
      , option [] ["avoid-reinstalls"]
          "Do not select versions that would destructively overwrite installed packages."
          installAvoidReinstalls (\v flags -> flags { installAvoidReinstalls = v })
741
          (yesNoOpt showOrParseArgs)
742

743
      , option [] ["force-reinstalls"]
744
          "Reinstall packages even if they will most likely break other installed packages."
745
          installOverrideReinstall (\v flags -> flags { installOverrideReinstall = v })
746
          (yesNoOpt showOrParseArgs)
747

748
749
750
      , option [] ["upgrade-dependencies"]
          "Pick the latest version for all dependencies, rather than trying to pick an installed version."
          installUpgradeDeps (\v flags -> flags { installUpgradeDeps = v })
751
          (yesNoOpt showOrParseArgs)
752

753
754
755
      , option [] ["only-dependencies"]
          "Install only the dependencies necessary to build the given packages"
          installOnlyDeps (\v flags -> flags { installOnlyDeps = v })
756
          (yesNoOpt showOrParseArgs)
757

758
759
760
761
762
      , option [] ["root-cmd"]
          "Command used to gain root privileges, when installing with --global."
          installRootCmd (\v flags -> flags { installRootCmd = v })
          (reqArg' "COMMAND" toFlag flagToList)

763
764
765
766
767
      , option [] ["symlink-bindir"]
          "Add symlinks to installed executables into this directory."
           installSymlinkBinDir (\v flags -> flags { installSymlinkBinDir = v })
           (reqArgFlag "DIR")

768
769
770
771
772
773
      , 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
774
775
          "Log all builds to file (name template can use $pkgid, $compiler, $os, $arch)"
          installLogFile (\v flags -> flags { installLogFile = v })
776
777
          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
                              (flagToList . fmap fromPathTemplate))
Duncan Coutts's avatar
Duncan Coutts committed
778

779
780
      , option [] ["remote-build-reporting"]
          "Generate build reports to send to a remote server (none, anonymous or detailed)."
781
          installBuildReports (\v flags -> flags { installBuildReports = v })
782
783
784
785
          (reqArg "LEVEL" (readP_to_E (const $ "report level must be 'none', "
                                            ++ "'anonymous' or 'detailed'")
                                      (toFlag `fmap` parse))
                          (flagToList . fmap display))
786

787
788
789
      , option [] ["one-shot"]
          "Do not record the packages in the world file."
          installOneShot (\v flags -> flags { installOneShot = v })
790
          (yesNoOpt showOrParseArgs)
791
792

      , option "j" ["jobs"]
793
        "Run NUM jobs simultaneously."
794
        installNumJobs (\v flags -> flags { installNumJobs = v })
795
796
797
        (reqArg "NUM" (readP_to_E (\_ -> "jobs should be a number")
                                  (fmap toFlag (Parse.readS_to_P reads)))
                      (map show . flagToList))
798
799
800
801
802
803
804
      ] ++ 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
             : []
805
          _ -> []
806
807

instance Monoid InstallFlags where
808
  mempty = InstallFlags {
809
810
811
812
813
    installDocumentation   = mempty,
    installHaddockIndex    = mempty,
    installDryRun          = mempty,
    installReinstall       = mempty,
    installAvoidReinstalls = mempty,
814
    installOverrideReinstall = mempty,
Andres Löh's avatar
Andres Löh committed
815
    installMaxBackjumps    = mempty,
816
    installUpgradeDeps     = mempty,
Andres Löh's avatar
Andres Löh committed
817
    installReorderGoals    = mempty,
818
    installIndependentGoals= mempty,
819
    installShadowPkgs      = mempty,
820
821
822
823
824
825
826
    installOnly            = mempty,
    installOnlyDeps        = mempty,
    installRootCmd         = mempty,
    installSummaryFile     = mempty,
    installLogFile         = mempty,
    installBuildReports    = mempty,
    installSymlinkBinDir   = mempty,
827
828
    installOneShot         = mempty,
    installNumJobs         = mempty
829
  }
830
  mappend a b = InstallFlags {
831
832
833
834
835
    installDocumentation   = combine installDocumentation,
    installHaddockIndex    = combine installHaddockIndex,
    installDryRun          = combine installDryRun,
    installReinstall       = combine installReinstall,
    installAvoidReinstalls = combine installAvoidReinstalls,
836
    installOverrideReinstall = combine installOverrideReinstall,
Andres Löh's avatar
Andres Löh committed
837
    installMaxBackjumps    = combine installMaxBackjumps,
838
    installUpgradeDeps     = combine installUpgradeDeps,
Andres Löh's avatar
Andres Löh committed
839
    installReorderGoals    = combine installReorderGoals,
840
    installIndependentGoals= combine installIndependentGoals,
841
    installShadowPkgs      = combine installShadowPkgs,
842
843
844
845
846
847
848
    installOnly            = combine installOnly,
    installOnlyDeps        = combine installOnlyDeps,
    installRootCmd         = combine installRootCmd,
    installSummaryFile     = combine installSummaryFile,
    installLogFile         = combine installLogFile,
    installBuildReports    = combine installBuildReports,
    installSymlinkBinDir   = combine installSymlinkBinDir,
849
850
    installOneShot         = combine installOneShot,
    installNumJobs         = combine installNumJobs
851
852
853
  }
    where combine field = field a `mappend` field b

854
855
856
857
858
859
860
861
862
-- ------------------------------------------------------------
-- * Upload flags
-- ------------------------------------------------------------

data UploadFlags = UploadFlags {
    uploadCheck     :: Flag Bool,
    uploadUsername  :: Flag Username,
    uploadPassword  :: Flag Password,
    uploadVerbosity :: Flag Verbosity
863
  }
864
865
866
867
868
869
870
871
872
873
874
875
876
877

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 $ \_ ->
878
         "You can store your Hackage login in the ~/.cabal/config file\n",
879
880
881
882
883
    commandUsage        = \pname ->
         "Usage: " ++ pname ++ " upload [FLAGS] [TARFILES]\n\n"
      ++ "Flags for upload:",
    commandDefaultFlags = defaultUploadFlags,
    commandOptions      = \_ ->
884
      [optionVerbosity uploadVerbosity (\v flags -> flags { uploadVerbosity = v })
885
886
887
888

      ,option ['c'] ["check"]
         "Do not upload, just do QA checks."
        uploadCheck (\v flags -> flags { uploadCheck = v })
889
        trueArg
890
891
892
893

      ,option ['u'] ["username"]
        "Hackage username."
        uploadUsername (\v flags -> flags { uploadUsername = v })
894
895
        (reqArg' "USERNAME" (toFlag . Username)
                            (flagToList . fmap unUsername))
896
897
898
899

      ,option ['p'] ["password"]
        "Hackage password."
        uploadPassword (\v flags -> flags { uploadPassword = v })
900
901
        (reqArg' "PASSWORD" (toFlag . Password)
                            (flagToList . fmap unPassword))
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
      ]
  }

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

920
921
922
923
924
925
926
927
-- ------------------------------------------------------------
-- * Init flags
-- ------------------------------------------------------------

emptyInitFlags :: IT.InitFlags
emptyInitFlags  = mempty

defaultInitFlags :: IT.InitFlags
928
defaultInitFlags  = emptyInitFlags { IT.initVerbosity = toFlag normal }
929
930
931
932
933

initCommand :: CommandUI IT.InitFlags
initCommand = CommandUI {
    commandName = "init",
    commandSynopsis = "Interactively create a .cabal file.",
934
935
936
937
938
939
940
941
942
943
944
945
    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:",
946
947
    commandDefaultFlags = defaultInitFlags,
    commandOptions = \_ ->
948
      [ option ['n'] ["non-interactive"]
949
950
951
952
953
954
955
956
957
        "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

958
      , option [] ["no-comments"]
959
960
961
962
963
        "Do not generate explanatory comments in the .cabal file."
        IT.noComments (\v flags -> flags { IT.noComments = v })
        trueArg

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

968
      , option [] ["package-dir"]
969
970
971
972
        "Root directory of the package (default = current directory)."
        IT.packageDir (\v flags -> flags { IT.packageDir = v })
        (reqArgFlag "DIRECTORY")

973
      , option ['p'] ["package-name"]
974
975
976
977
978
979
980
981
982
983
984
        "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))

985
      , option [] ["cabal-version"]
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."